diff --git a/cloudstack/AccountService.go b/cloudstack/AccountService.go index 66d61a51..0a71a4e6 100644 --- a/cloudstack/AccountService.go +++ b/cloudstack/AccountService.go @@ -485,6 +485,7 @@ type CreateAccountResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` Templatetotal int64 `json:"templatetotal"` @@ -811,6 +812,7 @@ type DisableAccountResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` Templatetotal int64 `json:"templatetotal"` @@ -1009,6 +1011,7 @@ type EnableAccountResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` Templatetotal int64 `json:"templatetotal"` @@ -1200,6 +1203,9 @@ func (p *ListAccountsParams) toURLValues() url.Values { if v, found := p.p["state"]; found { u.Set("state", v.(string)) } + if v, found := p.p["tag"]; found { + u.Set("tag", v.(string)) + } return u } @@ -1476,6 +1482,27 @@ func (p *ListAccountsParams) GetState() (string, bool) { return value, ok } +func (p *ListAccountsParams) SetTag(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["tag"] = v +} + +func (p *ListAccountsParams) ResetTag() { + if p.p != nil && p.p["tag"] != nil { + delete(p.p, "tag") + } +} + +func (p *ListAccountsParams) GetTag() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["tag"].(string) + return value, ok +} + // You should always use this function to get a new ListAccountsParams instance, // as then you are sure you have configured all required params func (s *AccountService) NewListAccountsParams() *ListAccountsParams { @@ -1634,6 +1661,7 @@ type Account struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` Templatetotal int64 `json:"templatetotal"` @@ -1984,6 +2012,7 @@ type ProjectAccount struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Tags []Tags `json:"tags"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` @@ -2006,6 +2035,7 @@ type Tags struct { Customer string `json:"customer"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Key string `json:"key"` Project string `json:"project"` Projectid string `json:"projectid"` @@ -2146,6 +2176,7 @@ type LockAccountResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` Templatetotal int64 `json:"templatetotal"` @@ -2367,6 +2398,7 @@ type MarkDefaultZoneForAccountResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` Templatetotal int64 `json:"templatetotal"` @@ -2664,6 +2696,7 @@ type UpdateAccountResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` Templatetotal int64 `json:"templatetotal"` diff --git a/cloudstack/AddressService.go b/cloudstack/AddressService.go index 43360d10..10e1f0cd 100644 --- a/cloudstack/AddressService.go +++ b/cloudstack/AddressService.go @@ -346,7 +346,9 @@ type AssociateIpAddressResponse struct { Associatednetworkname string `json:"associatednetworkname"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` + Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Hasannotations bool `json:"hasannotations"` Hasrules bool `json:"hasrules"` @@ -515,6 +517,10 @@ func (p *ListPublicIpAddressesParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("forloadbalancing", vv) } + if v, found := p.p["forsystemvms"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forsystemvms", vv) + } if v, found := p.p["forvirtualnetwork"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("forvirtualnetwork", vv) @@ -713,6 +719,27 @@ func (p *ListPublicIpAddressesParams) GetForloadbalancing() (bool, bool) { return value, ok } +func (p *ListPublicIpAddressesParams) SetForsystemvms(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forsystemvms"] = v +} + +func (p *ListPublicIpAddressesParams) ResetForsystemvms() { + if p.p != nil && p.p["forsystemvms"] != nil { + delete(p.p, "forsystemvms") + } +} + +func (p *ListPublicIpAddressesParams) GetForsystemvms() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forsystemvms"].(bool) + return value, ok +} + func (p *ListPublicIpAddressesParams) SetForvirtualnetwork(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1180,7 +1207,9 @@ type PublicIpAddress struct { Associatednetworkname string `json:"associatednetworkname"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` + Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Hasannotations bool `json:"hasannotations"` Hasrules bool `json:"hasrules"` @@ -1349,7 +1378,9 @@ type UpdateIpAddressResponse struct { Associatednetworkname string `json:"associatednetworkname"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` + Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Hasannotations bool `json:"hasannotations"` Hasrules bool `json:"hasrules"` diff --git a/cloudstack/AffinityGroupService.go b/cloudstack/AffinityGroupService.go index c0f157d9..f87901c9 100644 --- a/cloudstack/AffinityGroupService.go +++ b/cloudstack/AffinityGroupService.go @@ -245,18 +245,20 @@ func (s *AffinityGroupService) CreateAffinityGroup(p *CreateAffinityGroupParams) } type CreateAffinityGroupResponse struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } type DeleteAffinityGroupParams struct { @@ -980,18 +982,20 @@ type ListAffinityGroupsResponse struct { } type AffinityGroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } type UpdateVMAffinityGroupParams struct { @@ -1137,6 +1141,7 @@ type UpdateVMAffinityGroupResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -1148,6 +1153,7 @@ type UpdateVMAffinityGroupResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -1161,6 +1167,7 @@ type UpdateVMAffinityGroupResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -1198,6 +1205,7 @@ type UpdateVMAffinityGroupResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -1209,6 +1217,7 @@ type UpdateVMAffinityGroupResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -1220,6 +1229,7 @@ type UpdateVMAffinityGroupResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []UpdateVMAffinityGroupResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []UpdateVMAffinityGroupResponseSecuritygroupRule `json:"ingressrule"` @@ -1245,16 +1255,18 @@ type UpdateVMAffinityGroupResponseSecuritygroupRule struct { } type UpdateVMAffinityGroupResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *UpdateVMAffinityGroupResponse) UnmarshalJSON(b []byte) error { diff --git a/cloudstack/AutoScaleService.go b/cloudstack/AutoScaleService.go index 9e482d5e..6432747f 100644 --- a/cloudstack/AutoScaleService.go +++ b/cloudstack/AutoScaleService.go @@ -268,6 +268,7 @@ type CreateAutoScalePolicyResponse struct { Conditions []string `json:"conditions"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Duration int `json:"duration"` Id string `json:"id"` JobID string `json:"jobid"` @@ -569,6 +570,7 @@ type CreateAutoScaleVmGroupResponse struct { Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -1005,6 +1007,7 @@ type CreateAutoScaleVmProfileResponse struct { Autoscaleuserid string `json:"autoscaleuserid"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Expungevmgraceperiod int `json:"expungevmgraceperiod"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` @@ -1233,6 +1236,7 @@ type CreateConditionResponse struct { Countername string `json:"countername"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` @@ -1932,6 +1936,7 @@ type DisableAutoScaleVmGroupResponse struct { Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -2043,6 +2048,7 @@ type EnableAutoScaleVmGroupResponse struct { Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -2511,6 +2517,7 @@ type AutoScalePolicy struct { Conditions []string `json:"conditions"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Duration int `json:"duration"` Id string `json:"id"` JobID string `json:"jobid"` @@ -3017,6 +3024,7 @@ type AutoScaleVmGroup struct { Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -3459,6 +3467,7 @@ type AutoScaleVmProfile struct { Autoscaleuserid string `json:"autoscaleuserid"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Expungevmgraceperiod int `json:"expungevmgraceperiod"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` @@ -3825,6 +3834,7 @@ type Condition struct { Countername string `json:"countername"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` @@ -4324,6 +4334,7 @@ type UpdateAutoScalePolicyResponse struct { Conditions []string `json:"conditions"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Duration int `json:"duration"` Id string `json:"id"` JobID string `json:"jobid"` @@ -4620,6 +4631,7 @@ type UpdateAutoScaleVmGroupResponse struct { Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -5006,6 +5018,7 @@ type UpdateAutoScaleVmProfileResponse struct { Autoscaleuserid string `json:"autoscaleuserid"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Expungevmgraceperiod int `json:"expungevmgraceperiod"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` diff --git a/cloudstack/BrocadeVCSService.go b/cloudstack/BrocadeVCSService.go index a00bfc14..38258831 100644 --- a/cloudstack/BrocadeVCSService.go +++ b/cloudstack/BrocadeVCSService.go @@ -466,8 +466,11 @@ type BrocadeVcsDeviceNetwork struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Asnumber int64 `json:"asnumber"` + Asnumberid string `json:"asnumberid"` Associatednetwork string `json:"associatednetwork"` Associatednetworkid string `json:"associatednetworkid"` + Bgppeers []interface{} `json:"bgppeers"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -488,6 +491,8 @@ type BrocadeVcsDeviceNetwork struct { Icon interface{} `json:"icon"` Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` + Ip4routes []interface{} `json:"ip4routes"` + Ip4routing string `json:"ip4routing"` Ip6cidr string `json:"ip6cidr"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` diff --git a/cloudstack/ClusterService.go b/cloudstack/ClusterService.go index a8f48474..219ef404 100644 --- a/cloudstack/ClusterService.go +++ b/cloudstack/ClusterService.go @@ -72,6 +72,9 @@ func (p *AddClusterParams) toURLValues() url.Values { if v, found := p.p["allocationstate"]; found { u.Set("allocationstate", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["clustername"]; found { u.Set("clustername", v.(string)) } @@ -150,6 +153,27 @@ func (p *AddClusterParams) GetAllocationstate() (string, bool) { return value, ok } +func (p *AddClusterParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *AddClusterParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *AddClusterParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *AddClusterParams) SetClustername(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -562,6 +586,7 @@ func (s *ClusterService) AddCluster(p *AddClusterParams) (*AddClusterResponse, e type AddClusterResponse struct { Allocationstate string `json:"allocationstate"` + Arch string `json:"arch"` Capacity []AddClusterResponseCapacity `json:"capacity"` Clustertype string `json:"clustertype"` Cpuovercommitratio string `json:"cpuovercommitratio"` @@ -591,6 +616,7 @@ type AddClusterResponseCapacity struct { Percentused string `json:"percentused"` Podid string `json:"podid"` Podname string `json:"podname"` + Tag string `json:"tag"` Type int `json:"type"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` @@ -1602,6 +1628,7 @@ type ListClustersResponse struct { type Cluster struct { Allocationstate string `json:"allocationstate"` + Arch string `json:"arch"` Capacity []ClusterCapacity `json:"capacity"` Clustertype string `json:"clustertype"` Cpuovercommitratio string `json:"cpuovercommitratio"` @@ -1631,6 +1658,7 @@ type ClusterCapacity struct { Percentused string `json:"percentused"` Podid string `json:"podid"` Podname string `json:"podname"` + Tag string `json:"tag"` Type int `json:"type"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` @@ -2052,6 +2080,7 @@ type ListClustersMetricsResponse struct { type ClustersMetric struct { Allocationstate string `json:"allocationstate"` + Arch string `json:"arch"` Capacity []ClustersMetricCapacity `json:"capacity"` Clustertype string `json:"clustertype"` Cpuallocated string `json:"cpuallocated"` @@ -2063,6 +2092,7 @@ type ClustersMetric struct { Cputhreshold bool `json:"cputhreshold"` Cputotal string `json:"cputotal"` Cpuused string `json:"cpuused"` + Drsimbalance string `json:"drsimbalance"` Hasannotations bool `json:"hasannotations"` Hosts string `json:"hosts"` Hypervisortype string `json:"hypervisortype"` @@ -2099,6 +2129,7 @@ type ClustersMetricCapacity struct { Percentused string `json:"percentused"` Podid string `json:"podid"` Podname string `json:"podname"` + Tag string `json:"tag"` Type int `json:"type"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` @@ -2419,6 +2450,9 @@ func (p *UpdateClusterParams) toURLValues() url.Values { if v, found := p.p["allocationstate"]; found { u.Set("allocationstate", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["clustername"]; found { u.Set("clustername", v.(string)) } @@ -2458,6 +2492,27 @@ func (p *UpdateClusterParams) GetAllocationstate() (string, bool) { return value, ok } +func (p *UpdateClusterParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *UpdateClusterParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *UpdateClusterParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *UpdateClusterParams) SetClustername(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2593,6 +2648,7 @@ func (s *ClusterService) UpdateCluster(p *UpdateClusterParams) (*UpdateClusterRe type UpdateClusterResponse struct { Allocationstate string `json:"allocationstate"` + Arch string `json:"arch"` Capacity []UpdateClusterResponseCapacity `json:"capacity"` Clustertype string `json:"clustertype"` Cpuovercommitratio string `json:"cpuovercommitratio"` @@ -2622,6 +2678,7 @@ type UpdateClusterResponseCapacity struct { Percentused string `json:"percentused"` Podid string `json:"podid"` Podname string `json:"podname"` + Tag string `json:"tag"` Type int `json:"type"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` diff --git a/cloudstack/ConfigurationService.go b/cloudstack/ConfigurationService.go index 0a1e39b7..93c1ce4a 100644 --- a/cloudstack/ConfigurationService.go +++ b/cloudstack/ConfigurationService.go @@ -81,6 +81,7 @@ type Capability struct { Allowusercreateprojects bool `json:"allowusercreateprojects"` Allowuserexpungerecovervm bool `json:"allowuserexpungerecovervm"` Allowuserexpungerecovervolume bool `json:"allowuserexpungerecovervolume"` + Allowuserforcestopvm bool `json:"allowuserforcestopvm"` Allowuserviewalldomainaccounts bool `json:"allowuserviewalldomainaccounts"` Allowuserviewdestroyedvm bool `json:"allowuserviewdestroyedvm"` Apilimitinterval int `json:"apilimitinterval"` @@ -103,6 +104,8 @@ type Capability struct { Projectinviterequired bool `json:"projectinviterequired"` Regionsecondaryenabled bool `json:"regionsecondaryenabled"` Securitygroupsenabled bool `json:"securitygroupsenabled"` + Sharedfsvmmincpucount int `json:"sharedfsvmmincpucount"` + Sharedfsvmminramsize int `json:"sharedfsvmminramsize"` SupportELB string `json:"supportELB"` Userpublictemplateenabled bool `json:"userpublictemplateenabled"` } diff --git a/cloudstack/DiskOfferingService.go b/cloudstack/DiskOfferingService.go index e3228fe3..079aaea6 100644 --- a/cloudstack/DiskOfferingService.go +++ b/cloudstack/DiskOfferingService.go @@ -886,7 +886,9 @@ type CreateDiskOfferingResponse struct { Miniops int64 `json:"miniops"` Name string `json:"name"` Provisioningtype string `json:"provisioningtype"` + State string `json:"state"` Storagetype string `json:"storagetype"` + Suitableforvirtualmachine bool `json:"suitableforvirtualmachine"` Tags string `json:"tags"` Vspherestoragepolicy string `json:"vspherestoragepolicy"` Zone string `json:"zone"` @@ -1034,12 +1036,18 @@ func (p *ListDiskOfferingsParams) toURLValues() url.Values { if v, found := p.p["projectid"]; found { u.Set("projectid", v.(string)) } + if v, found := p.p["state"]; found { + u.Set("state", v.(string)) + } if v, found := p.p["storageid"]; found { u.Set("storageid", v.(string)) } if v, found := p.p["storagetype"]; found { u.Set("storagetype", v.(string)) } + if v, found := p.p["virtualmachineid"]; found { + u.Set("virtualmachineid", v.(string)) + } if v, found := p.p["volumeid"]; found { u.Set("volumeid", v.(string)) } @@ -1280,6 +1288,27 @@ func (p *ListDiskOfferingsParams) GetProjectid() (string, bool) { return value, ok } +func (p *ListDiskOfferingsParams) SetState(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["state"] = v +} + +func (p *ListDiskOfferingsParams) ResetState() { + if p.p != nil && p.p["state"] != nil { + delete(p.p, "state") + } +} + +func (p *ListDiskOfferingsParams) GetState() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["state"].(string) + return value, ok +} + func (p *ListDiskOfferingsParams) SetStorageid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1322,6 +1351,27 @@ func (p *ListDiskOfferingsParams) GetStoragetype() (string, bool) { return value, ok } +func (p *ListDiskOfferingsParams) SetVirtualmachineid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["virtualmachineid"] = v +} + +func (p *ListDiskOfferingsParams) ResetVirtualmachineid() { + if p.p != nil && p.p["virtualmachineid"] != nil { + delete(p.p, "virtualmachineid") + } +} + +func (p *ListDiskOfferingsParams) GetVirtualmachineid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["virtualmachineid"].(string) + return value, ok +} + func (p *ListDiskOfferingsParams) SetVolumeid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1509,7 +1559,9 @@ type DiskOffering struct { Miniops int64 `json:"miniops"` Name string `json:"name"` Provisioningtype string `json:"provisioningtype"` + State string `json:"state"` Storagetype string `json:"storagetype"` + Suitableforvirtualmachine bool `json:"suitableforvirtualmachine"` Tags string `json:"tags"` Vspherestoragepolicy string `json:"vspherestoragepolicy"` Zone string `json:"zone"` @@ -1596,6 +1648,9 @@ func (p *UpdateDiskOfferingParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("sortkey", vv) } + if v, found := p.p["state"]; found { + u.Set("state", v.(string)) + } if v, found := p.p["tags"]; found { u.Set("tags", v.(string)) } @@ -2004,6 +2059,27 @@ func (p *UpdateDiskOfferingParams) GetSortkey() (int, bool) { return value, ok } +func (p *UpdateDiskOfferingParams) SetState(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["state"] = v +} + +func (p *UpdateDiskOfferingParams) ResetState() { + if p.p != nil && p.p["state"] != nil { + delete(p.p, "state") + } +} + +func (p *UpdateDiskOfferingParams) GetState() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["state"].(string) + return value, ok +} + func (p *UpdateDiskOfferingParams) SetTags(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2104,7 +2180,9 @@ type UpdateDiskOfferingResponse struct { Miniops int64 `json:"miniops"` Name string `json:"name"` Provisioningtype string `json:"provisioningtype"` + State string `json:"state"` Storagetype string `json:"storagetype"` + Suitableforvirtualmachine bool `json:"suitableforvirtualmachine"` Tags string `json:"tags"` Vspherestoragepolicy string `json:"vspherestoragepolicy"` Zone string `json:"zone"` diff --git a/cloudstack/DomainService.go b/cloudstack/DomainService.go index 34480441..d6adbe8a 100644 --- a/cloudstack/DomainService.go +++ b/cloudstack/DomainService.go @@ -222,6 +222,7 @@ type CreateDomainResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` Templatetotal int64 `json:"templatetotal"` @@ -703,6 +704,7 @@ type DomainChildren struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` Templatetotal int64 `json:"templatetotal"` @@ -759,6 +761,9 @@ func (p *ListDomainsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("showicon", vv) } + if v, found := p.p["tag"]; found { + u.Set("tag", v.(string)) + } return u } @@ -951,6 +956,27 @@ func (p *ListDomainsParams) GetShowicon() (bool, bool) { return value, ok } +func (p *ListDomainsParams) SetTag(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["tag"] = v +} + +func (p *ListDomainsParams) ResetTag() { + if p.p != nil && p.p["tag"] != nil { + delete(p.p, "tag") + } +} + +func (p *ListDomainsParams) GetTag() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["tag"].(string) + return value, ok +} + // You should always use this function to get a new ListDomainsParams instance, // as then you are sure you have configured all required params func (s *DomainService) NewListDomainsParams() *ListDomainsParams { @@ -1102,6 +1128,7 @@ type Domain struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` Templatetotal int64 `json:"templatetotal"` @@ -1268,6 +1295,7 @@ type UpdateDomainResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` Templatetotal int64 `json:"templatetotal"` diff --git a/cloudstack/EventService.go b/cloudstack/EventService.go index 27556150..c55c86f0 100644 --- a/cloudstack/EventService.go +++ b/cloudstack/EventService.go @@ -960,6 +960,7 @@ type Event struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` diff --git a/cloudstack/FirewallService.go b/cloudstack/FirewallService.go index 8adbda93..6aa94f17 100644 --- a/cloudstack/FirewallService.go +++ b/cloudstack/FirewallService.go @@ -4523,7 +4523,7 @@ func (s *FirewallService) NewCreateIpv6FirewallRuleParams(networkid string, prot return p } -// Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC) +// Creates an Ipv6 firewall rule in the given network (the network must not belong to VPC) func (s *FirewallService) CreateIpv6FirewallRule(p *CreateIpv6FirewallRuleParams) (*CreateIpv6FirewallRuleResponse, error) { resp, err := s.cs.newRequest("createIpv6FirewallRule", p.toURLValues()) if err != nil { diff --git a/cloudstack/HostService.go b/cloudstack/HostService.go index 39805645..cd5a9b15 100644 --- a/cloudstack/HostService.go +++ b/cloudstack/HostService.go @@ -387,6 +387,7 @@ func (s *HostService) AddBaremetalHost(p *AddBaremetalHostParams) (*AddBaremetal type AddBaremetalHostResponse struct { Annotation string `json:"annotation"` + Arch string `json:"arch"` Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -408,6 +409,7 @@ type AddBaremetalHostResponse struct { Disksizetotal int64 `json:"disksizetotal"` Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` + Explicithosttags string `json:"explicithosttags"` Gpugroup []AddBaremetalHostResponseGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` @@ -417,6 +419,8 @@ type AddBaremetalHostResponse struct { Hypervisor string `json:"hypervisor"` Hypervisorversion string `json:"hypervisorversion"` Id string `json:"id"` + Implicithosttags string `json:"implicithosttags"` + Instanceconversionsupported bool `json:"instanceconversionsupported"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` Istagarule bool `json:"istagarule"` @@ -910,6 +914,7 @@ func (s *HostService) AddHost(p *AddHostParams) (*AddHostResponse, error) { type AddHostResponse struct { Annotation string `json:"annotation"` + Arch string `json:"arch"` Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -931,6 +936,7 @@ type AddHostResponse struct { Disksizetotal int64 `json:"disksizetotal"` Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` + Explicithosttags string `json:"explicithosttags"` Gpugroup []AddHostResponseGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` @@ -940,6 +946,8 @@ type AddHostResponse struct { Hypervisor string `json:"hypervisor"` Hypervisorversion string `json:"hypervisorversion"` Id string `json:"id"` + Implicithosttags string `json:"implicithosttags"` + Instanceconversionsupported bool `json:"instanceconversionsupported"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` Istagarule bool `json:"istagarule"` @@ -1173,6 +1181,7 @@ func (s *HostService) CancelHostMaintenance(p *CancelHostMaintenanceParams) (*Ca type CancelHostMaintenanceResponse struct { Annotation string `json:"annotation"` + Arch string `json:"arch"` Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -1194,6 +1203,7 @@ type CancelHostMaintenanceResponse struct { Disksizetotal int64 `json:"disksizetotal"` Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` + Explicithosttags string `json:"explicithosttags"` Gpugroup []CancelHostMaintenanceResponseGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` @@ -1203,6 +1213,8 @@ type CancelHostMaintenanceResponse struct { Hypervisor string `json:"hypervisor"` Hypervisorversion string `json:"hypervisorversion"` Id string `json:"id"` + Implicithosttags string `json:"implicithosttags"` + Instanceconversionsupported bool `json:"instanceconversionsupported"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` Istagarule bool `json:"istagarule"` @@ -2092,12 +2104,14 @@ type HostForMigration struct { Disksizeallocated int64 `json:"disksizeallocated"` Disksizetotal int64 `json:"disksizetotal"` Events string `json:"events"` + Explicithosttags string `json:"explicithosttags"` Hahost bool `json:"hahost"` Hasenoughcapacity bool `json:"hasenoughcapacity"` Hosttags string `json:"hosttags"` Hypervisor string `json:"hypervisor"` Hypervisorversion string `json:"hypervisorversion"` Id string `json:"id"` + Implicithosttags string `json:"implicithosttags"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` JobID string `json:"jobid"` @@ -2500,11 +2514,12 @@ type ListHostTagsResponse struct { } type HostTag struct { - Hostid int64 `json:"hostid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` + Hostid int64 `json:"hostid"` + Id string `json:"id"` + Isimplicit bool `json:"isimplicit"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` } type ListHostsParams struct { @@ -3045,6 +3060,7 @@ type ListHostsResponse struct { type Host struct { Annotation string `json:"annotation"` + Arch string `json:"arch"` Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -3066,6 +3082,7 @@ type Host struct { Disksizetotal int64 `json:"disksizetotal"` Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` + Explicithosttags string `json:"explicithosttags"` Gpugroup []HostGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` @@ -3075,6 +3092,8 @@ type Host struct { Hypervisor string `json:"hypervisor"` Hypervisorversion string `json:"hypervisorversion"` Id string `json:"id"` + Implicithosttags string `json:"implicithosttags"` + Instanceconversionsupported bool `json:"instanceconversionsupported"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` Istagarule bool `json:"istagarule"` @@ -3663,6 +3682,7 @@ type ListHostsMetricsResponse struct { type HostsMetric struct { Annotation string `json:"annotation"` + Arch string `json:"arch"` Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -3691,6 +3711,7 @@ type HostsMetric struct { Disksizetotal int64 `json:"disksizetotal"` Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` + Explicithosttags string `json:"explicithosttags"` Gpugroup []HostsMetricGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` @@ -3700,6 +3721,8 @@ type HostsMetric struct { Hypervisor string `json:"hypervisor"` Hypervisorversion string `json:"hypervisorversion"` Id string `json:"id"` + Implicithosttags string `json:"implicithosttags"` + Instanceconversionsupported bool `json:"instanceconversionsupported"` Instances string `json:"instances"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` @@ -3844,6 +3867,7 @@ func (s *HostService) PrepareHostForMaintenance(p *PrepareHostForMaintenancePara type PrepareHostForMaintenanceResponse struct { Annotation string `json:"annotation"` + Arch string `json:"arch"` Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -3865,6 +3889,7 @@ type PrepareHostForMaintenanceResponse struct { Disksizetotal int64 `json:"disksizetotal"` Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` + Explicithosttags string `json:"explicithosttags"` Gpugroup []PrepareHostForMaintenanceResponseGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` @@ -3874,6 +3899,8 @@ type PrepareHostForMaintenanceResponse struct { Hypervisor string `json:"hypervisor"` Hypervisorversion string `json:"hypervisorversion"` Id string `json:"id"` + Implicithosttags string `json:"implicithosttags"` + Instanceconversionsupported bool `json:"instanceconversionsupported"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` Istagarule bool `json:"istagarule"` @@ -4006,6 +4033,7 @@ func (s *HostService) ReconnectHost(p *ReconnectHostParams) (*ReconnectHostRespo type ReconnectHostResponse struct { Annotation string `json:"annotation"` + Arch string `json:"arch"` Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -4027,6 +4055,7 @@ type ReconnectHostResponse struct { Disksizetotal int64 `json:"disksizetotal"` Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` + Explicithosttags string `json:"explicithosttags"` Gpugroup []ReconnectHostResponseGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` @@ -4036,6 +4065,8 @@ type ReconnectHostResponse struct { Hypervisor string `json:"hypervisor"` Hypervisorversion string `json:"hypervisorversion"` Id string `json:"id"` + Implicithosttags string `json:"implicithosttags"` + Instanceconversionsupported bool `json:"instanceconversionsupported"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` Istagarule bool `json:"istagarule"` @@ -4482,6 +4513,7 @@ func (s *HostService) UpdateHost(p *UpdateHostParams) (*UpdateHostResponse, erro type UpdateHostResponse struct { Annotation string `json:"annotation"` + Arch string `json:"arch"` Capabilities string `json:"capabilities"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -4503,6 +4535,7 @@ type UpdateHostResponse struct { Disksizetotal int64 `json:"disksizetotal"` Encryptionsupported bool `json:"encryptionsupported"` Events string `json:"events"` + Explicithosttags string `json:"explicithosttags"` Gpugroup []UpdateHostResponseGpugroup `json:"gpugroup"` Hahost bool `json:"hahost"` Hasannotations bool `json:"hasannotations"` @@ -4512,6 +4545,8 @@ type UpdateHostResponse struct { Hypervisor string `json:"hypervisor"` Hypervisorversion string `json:"hypervisorversion"` Id string `json:"id"` + Implicithosttags string `json:"implicithosttags"` + Instanceconversionsupported bool `json:"instanceconversionsupported"` Ipaddress string `json:"ipaddress"` Islocalstorageactive bool `json:"islocalstorageactive"` Istagarule bool `json:"istagarule"` diff --git a/cloudstack/HypervisorService.go b/cloudstack/HypervisorService.go index 949033b8..7c89bcdf 100644 --- a/cloudstack/HypervisorService.go +++ b/cloudstack/HypervisorService.go @@ -325,6 +325,12 @@ func (p *UpdateHypervisorCapabilitiesParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["hypervisor"]; found { + u.Set("hypervisor", v.(string)) + } + if v, found := p.p["hypervisorversion"]; found { + u.Set("hypervisorversion", v.(string)) + } if v, found := p.p["id"]; found { u.Set("id", v.(string)) } @@ -355,6 +361,48 @@ func (p *UpdateHypervisorCapabilitiesParams) toURLValues() url.Values { return u } +func (p *UpdateHypervisorCapabilitiesParams) SetHypervisor(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["hypervisor"] = v +} + +func (p *UpdateHypervisorCapabilitiesParams) ResetHypervisor() { + if p.p != nil && p.p["hypervisor"] != nil { + delete(p.p, "hypervisor") + } +} + +func (p *UpdateHypervisorCapabilitiesParams) GetHypervisor() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["hypervisor"].(string) + return value, ok +} + +func (p *UpdateHypervisorCapabilitiesParams) SetHypervisorversion(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["hypervisorversion"] = v +} + +func (p *UpdateHypervisorCapabilitiesParams) ResetHypervisorversion() { + if p.p != nil && p.p["hypervisorversion"] != nil { + delete(p.p, "hypervisorversion") + } +} + +func (p *UpdateHypervisorCapabilitiesParams) GetHypervisorversion() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["hypervisorversion"].(string) + return value, ok +} + func (p *UpdateHypervisorCapabilitiesParams) SetId(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/ISOService.go b/cloudstack/ISOService.go index 1c055bf6..ac00d453 100644 --- a/cloudstack/ISOService.go +++ b/cloudstack/ISOService.go @@ -197,6 +197,7 @@ type AttachIsoResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -208,6 +209,7 @@ type AttachIsoResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -221,6 +223,7 @@ type AttachIsoResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -258,6 +261,7 @@ type AttachIsoResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -269,6 +273,7 @@ type AttachIsoResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -280,6 +285,7 @@ type AttachIsoResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []AttachIsoResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []AttachIsoResponseSecuritygroupRule `json:"ingressrule"` @@ -305,16 +311,18 @@ type AttachIsoResponseSecuritygroupRule struct { } type AttachIsoResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *AttachIsoResponse) UnmarshalJSON(b []byte) error { @@ -500,6 +508,7 @@ func (s *ISOService) CopyIso(p *CopyIsoParams) (*CopyIsoResponse, error) { type CopyIsoResponse struct { Account string `json:"account"` Accountid string `json:"accountid"` + Arch string `json:"arch"` Bits int `json:"bits"` Bootable bool `json:"bootable"` Checksum string `json:"checksum"` @@ -513,6 +522,7 @@ type CopyIsoResponse struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` @@ -805,6 +815,7 @@ type DetachIsoResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -816,6 +827,7 @@ type DetachIsoResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -829,6 +841,7 @@ type DetachIsoResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -866,6 +879,7 @@ type DetachIsoResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -877,6 +891,7 @@ type DetachIsoResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -888,6 +903,7 @@ type DetachIsoResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []DetachIsoResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []DetachIsoResponseSecuritygroupRule `json:"ingressrule"` @@ -913,16 +929,18 @@ type DetachIsoResponseSecuritygroupRule struct { } type DetachIsoResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *DetachIsoResponse) UnmarshalJSON(b []byte) error { @@ -1244,6 +1262,9 @@ func (p *ListIsosParams) toURLValues() url.Values { if v, found := p.p["account"]; found { u.Set("account", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["bootable"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("bootable", vv) @@ -1345,6 +1366,27 @@ func (p *ListIsosParams) GetAccount() (string, bool) { return value, ok } +func (p *ListIsosParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListIsosParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListIsosParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListIsosParams) SetBootable(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1902,6 +1944,7 @@ type ListIsosResponse struct { type Iso struct { Account string `json:"account"` Accountid string `json:"accountid"` + Arch string `json:"arch"` Bits int `json:"bits"` Bootable bool `json:"bootable"` Checksum string `json:"checksum"` @@ -1915,6 +1958,7 @@ type Iso struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` @@ -1995,6 +2039,9 @@ func (p *RegisterIsoParams) toURLValues() url.Values { if v, found := p.p["account"]; found { u.Set("account", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["bootable"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("bootable", vv) @@ -2074,6 +2121,27 @@ func (p *RegisterIsoParams) GetAccount() (string, bool) { return value, ok } +func (p *RegisterIsoParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *RegisterIsoParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *RegisterIsoParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *RegisterIsoParams) SetBootable(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2444,6 +2512,7 @@ func (s *ISOService) RegisterIso(p *RegisterIsoParams) (*RegisterIsoResponse, er type RegisterIsoResponse struct { Account string `json:"account"` Accountid string `json:"accountid"` + Arch string `json:"arch"` Bits int `json:"bits"` Bootable bool `json:"bootable"` Checksum string `json:"checksum"` @@ -2457,6 +2526,7 @@ type RegisterIsoResponse struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` @@ -2534,6 +2604,9 @@ func (p *UpdateIsoParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["bootable"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("bootable", vv) @@ -2590,6 +2663,27 @@ func (p *UpdateIsoParams) toURLValues() url.Values { return u } +func (p *UpdateIsoParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *UpdateIsoParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *UpdateIsoParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *UpdateIsoParams) SetBootable(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2911,6 +3005,7 @@ func (s *ISOService) UpdateIso(p *UpdateIsoParams) (*UpdateIsoResponse, error) { type UpdateIsoResponse struct { Account string `json:"account"` Accountid string `json:"accountid"` + Arch string `json:"arch"` Bits int `json:"bits"` Bootable bool `json:"bootable"` Checksum string `json:"checksum"` @@ -2924,6 +3019,7 @@ type UpdateIsoResponse struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` diff --git a/cloudstack/InternalLBService.go b/cloudstack/InternalLBService.go index 9c4f1e10..b4a27c8b 100644 --- a/cloudstack/InternalLBService.go +++ b/cloudstack/InternalLBService.go @@ -1044,6 +1044,7 @@ type InternalLoadBalancerVM struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gateway string `json:"gateway"` Guestipaddress string `json:"guestipaddress"` Guestmacaddress string `json:"guestmacaddress"` @@ -1190,6 +1191,7 @@ type StartInternalLoadBalancerVMResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gateway string `json:"gateway"` Guestipaddress string `json:"guestipaddress"` Guestmacaddress string `json:"guestmacaddress"` @@ -1361,6 +1363,7 @@ type StopInternalLoadBalancerVMResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gateway string `json:"gateway"` Guestipaddress string `json:"guestipaddress"` Guestmacaddress string `json:"guestmacaddress"` diff --git a/cloudstack/KubernetesService.go b/cloudstack/KubernetesService.go index 2aaf3523..9b066730 100644 --- a/cloudstack/KubernetesService.go +++ b/cloudstack/KubernetesService.go @@ -73,6 +73,9 @@ func (p *AddKubernetesSupportedVersionParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["checksum"]; found { u.Set("checksum", v.(string)) } @@ -103,6 +106,27 @@ func (p *AddKubernetesSupportedVersionParams) toURLValues() url.Values { return u } +func (p *AddKubernetesSupportedVersionParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *AddKubernetesSupportedVersionParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *AddKubernetesSupportedVersionParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *AddKubernetesSupportedVersionParams) SetChecksum(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -854,6 +878,7 @@ type CreateKubernetesClusterResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Endpoint string `json:"endpoint"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -1593,6 +1618,7 @@ type KubernetesCluster struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Endpoint string `json:"endpoint"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -2175,6 +2201,7 @@ type ScaleKubernetesClusterResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Endpoint string `json:"endpoint"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -2295,6 +2322,7 @@ type StartKubernetesClusterResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Endpoint string `json:"endpoint"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -2627,6 +2655,7 @@ type UpgradeKubernetesClusterResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Endpoint string `json:"endpoint"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` diff --git a/cloudstack/LDAPService.go b/cloudstack/LDAPService.go index 4c25f23b..4d3a707d 100644 --- a/cloudstack/LDAPService.go +++ b/cloudstack/LDAPService.go @@ -1196,6 +1196,7 @@ type LdapCreateAccountResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` Templatetotal int64 `json:"templatetotal"` diff --git a/cloudstack/LimitService.go b/cloudstack/LimitService.go index 81b65132..58e74e5e 100644 --- a/cloudstack/LimitService.go +++ b/cloudstack/LimitService.go @@ -131,6 +131,9 @@ func (p *ListResourceLimitsParams) toURLValues() url.Values { if v, found := p.p["resourcetypename"]; found { u.Set("resourcetypename", v.(string)) } + if v, found := p.p["tag"]; found { + u.Set("tag", v.(string)) + } return u } @@ -365,6 +368,27 @@ func (p *ListResourceLimitsParams) GetResourcetypename() (string, bool) { return value, ok } +func (p *ListResourceLimitsParams) SetTag(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["tag"] = v +} + +func (p *ListResourceLimitsParams) ResetTag() { + if p.p != nil && p.p["tag"] != nil { + delete(p.p, "tag") + } +} + +func (p *ListResourceLimitsParams) GetTag() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["tag"].(string) + return value, ok +} + // You should always use this function to get a new ListResourceLimitsParams instance, // as then you are sure you have configured all required params func (s *LimitService) NewListResourceLimitsParams() *ListResourceLimitsParams { @@ -397,6 +421,7 @@ type ResourceLimit struct { Account string `json:"account"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Max int64 `json:"max"` @@ -404,6 +429,7 @@ type ResourceLimit struct { Projectid string `json:"projectid"` Resourcetype string `json:"resourcetype"` Resourcetypename string `json:"resourcetypename"` + Tag string `json:"tag"` } type ResetApiLimitParams struct { @@ -521,6 +547,9 @@ func (p *UpdateResourceCountParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("resourcetype", vv) } + if v, found := p.p["tag"]; found { + u.Set("tag", v.(string)) + } return u } @@ -608,6 +637,27 @@ func (p *UpdateResourceCountParams) GetResourcetype() (int, bool) { return value, ok } +func (p *UpdateResourceCountParams) SetTag(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["tag"] = v +} + +func (p *UpdateResourceCountParams) ResetTag() { + if p.p != nil && p.p["tag"] != nil { + delete(p.p, "tag") + } +} + +func (p *UpdateResourceCountParams) GetTag() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["tag"].(string) + return value, ok +} + // You should always use this function to get a new UpdateResourceCountParams instance, // as then you are sure you have configured all required params func (s *LimitService) NewUpdateResourceCountParams(domainid string) *UpdateResourceCountParams { @@ -617,7 +667,7 @@ func (s *LimitService) NewUpdateResourceCountParams(domainid string) *UpdateReso return p } -// Recalculate and update resource count for an account or domain. +// Recalculate and update resource count for an account or domain. This also executes some cleanup tasks before calculating resource counts. func (s *LimitService) UpdateResourceCount(p *UpdateResourceCountParams) (*UpdateResourceCountResponse, error) { resp, err := s.cs.newRequest("updateResourceCount", p.toURLValues()) if err != nil { @@ -636,6 +686,7 @@ type UpdateResourceCountResponse struct { Account string `json:"account"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Project string `json:"project"` @@ -643,6 +694,7 @@ type UpdateResourceCountResponse struct { Resourcecount int64 `json:"resourcecount"` Resourcetype string `json:"resourcetype"` Resourcetypename string `json:"resourcetypename"` + Tag string `json:"tag"` } type UpdateResourceLimitParams struct { @@ -671,6 +723,9 @@ func (p *UpdateResourceLimitParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("resourcetype", vv) } + if v, found := p.p["tag"]; found { + u.Set("tag", v.(string)) + } return u } @@ -779,6 +834,27 @@ func (p *UpdateResourceLimitParams) GetResourcetype() (int, bool) { return value, ok } +func (p *UpdateResourceLimitParams) SetTag(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["tag"] = v +} + +func (p *UpdateResourceLimitParams) ResetTag() { + if p.p != nil && p.p["tag"] != nil { + delete(p.p, "tag") + } +} + +func (p *UpdateResourceLimitParams) GetTag() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["tag"].(string) + return value, ok +} + // You should always use this function to get a new UpdateResourceLimitParams instance, // as then you are sure you have configured all required params func (s *LimitService) NewUpdateResourceLimitParams(resourcetype int) *UpdateResourceLimitParams { @@ -807,6 +883,7 @@ type UpdateResourceLimitResponse struct { Account string `json:"account"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Max int64 `json:"max"` @@ -814,4 +891,5 @@ type UpdateResourceLimitResponse struct { Projectid string `json:"projectid"` Resourcetype string `json:"resourcetype"` Resourcetypename string `json:"resourcetypename"` + Tag string `json:"tag"` } diff --git a/cloudstack/LoadBalancerService.go b/cloudstack/LoadBalancerService.go index 5a40d051..674a22af 100644 --- a/cloudstack/LoadBalancerService.go +++ b/cloudstack/LoadBalancerService.go @@ -1267,6 +1267,7 @@ type CreateGlobalLoadBalancerRuleResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gslbdomainname string `json:"gslbdomainname"` Gslblbmethod string `json:"gslblbmethod"` Gslbservicetype string `json:"gslbservicetype"` @@ -1288,6 +1289,7 @@ type CreateGlobalLoadBalancerRuleResponseLoadbalancerrule struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` Name string `json:"name"` @@ -2123,6 +2125,7 @@ type CreateLoadBalancerResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` JobID string `json:"jobid"` @@ -2558,6 +2561,7 @@ type CreateLoadBalancerRuleResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` JobID string `json:"jobid"` @@ -3564,6 +3568,7 @@ type GlobalLoadBalancerRule struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gslbdomainname string `json:"gslbdomainname"` Gslblbmethod string `json:"gslblbmethod"` Gslbservicetype string `json:"gslbservicetype"` @@ -3585,6 +3590,7 @@ type GlobalLoadBalancerRuleLoadbalancerrule struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` Name string `json:"name"` @@ -4842,6 +4848,7 @@ type LoadBalancerRule struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` JobID string `json:"jobid"` @@ -5383,6 +5390,7 @@ type LoadBalancer struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` JobID string `json:"jobid"` @@ -6227,6 +6235,7 @@ type UpdateGlobalLoadBalancerRuleResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gslbdomainname string `json:"gslbdomainname"` Gslblbmethod string `json:"gslblbmethod"` Gslbservicetype string `json:"gslbservicetype"` @@ -6248,6 +6257,7 @@ type UpdateGlobalLoadBalancerRuleResponseLoadbalancerrule struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` Name string `json:"name"` @@ -6705,6 +6715,7 @@ type UpdateLoadBalancerResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` JobID string `json:"jobid"` @@ -6965,6 +6976,7 @@ type UpdateLoadBalancerRuleResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` JobID string `json:"jobid"` diff --git a/cloudstack/NetworkOfferingService.go b/cloudstack/NetworkOfferingService.go index 3f0e3c2c..3572bad0 100644 --- a/cloudstack/NetworkOfferingService.go +++ b/cloudstack/NetworkOfferingService.go @@ -78,6 +78,10 @@ func (p *CreateNetworkOfferingParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("enable", vv) } + if v, found := p.p["fornsx"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("fornsx", vv) + } if v, found := p.p["fortungsten"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("fortungsten", vv) @@ -107,10 +111,24 @@ func (p *CreateNetworkOfferingParams) toURLValues() url.Values { if v, found := p.p["name"]; found { u.Set("name", v.(string)) } + if v, found := p.p["networkmode"]; found { + u.Set("networkmode", v.(string)) + } if v, found := p.p["networkrate"]; found { vv := strconv.Itoa(v.(int)) u.Set("networkrate", vv) } + if v, found := p.p["nsxsupportlb"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("nsxsupportlb", vv) + } + if v, found := p.p["nsxsupportsinternallb"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("nsxsupportsinternallb", vv) + } + if v, found := p.p["routingmode"]; found { + u.Set("routingmode", v.(string)) + } if v, found := p.p["servicecapabilitylist"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -128,6 +146,10 @@ func (p *CreateNetworkOfferingParams) toURLValues() url.Values { u.Set(fmt.Sprintf("serviceproviderlist[%d].provider", i), m[k]) } } + if v, found := p.p["specifyasnumber"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("specifyasnumber", vv) + } if v, found := p.p["specifyipranges"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("specifyipranges", vv) @@ -300,6 +322,27 @@ func (p *CreateNetworkOfferingParams) GetEnable() (bool, bool) { return value, ok } +func (p *CreateNetworkOfferingParams) SetFornsx(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["fornsx"] = v +} + +func (p *CreateNetworkOfferingParams) ResetFornsx() { + if p.p != nil && p.p["fornsx"] != nil { + delete(p.p, "fornsx") + } +} + +func (p *CreateNetworkOfferingParams) GetFornsx() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["fornsx"].(bool) + return value, ok +} + func (p *CreateNetworkOfferingParams) SetFortungsten(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -468,6 +511,27 @@ func (p *CreateNetworkOfferingParams) GetName() (string, bool) { return value, ok } +func (p *CreateNetworkOfferingParams) SetNetworkmode(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["networkmode"] = v +} + +func (p *CreateNetworkOfferingParams) ResetNetworkmode() { + if p.p != nil && p.p["networkmode"] != nil { + delete(p.p, "networkmode") + } +} + +func (p *CreateNetworkOfferingParams) GetNetworkmode() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["networkmode"].(string) + return value, ok +} + func (p *CreateNetworkOfferingParams) SetNetworkrate(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -489,6 +553,69 @@ func (p *CreateNetworkOfferingParams) GetNetworkrate() (int, bool) { return value, ok } +func (p *CreateNetworkOfferingParams) SetNsxsupportlb(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nsxsupportlb"] = v +} + +func (p *CreateNetworkOfferingParams) ResetNsxsupportlb() { + if p.p != nil && p.p["nsxsupportlb"] != nil { + delete(p.p, "nsxsupportlb") + } +} + +func (p *CreateNetworkOfferingParams) GetNsxsupportlb() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nsxsupportlb"].(bool) + return value, ok +} + +func (p *CreateNetworkOfferingParams) SetNsxsupportsinternallb(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nsxsupportsinternallb"] = v +} + +func (p *CreateNetworkOfferingParams) ResetNsxsupportsinternallb() { + if p.p != nil && p.p["nsxsupportsinternallb"] != nil { + delete(p.p, "nsxsupportsinternallb") + } +} + +func (p *CreateNetworkOfferingParams) GetNsxsupportsinternallb() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nsxsupportsinternallb"].(bool) + return value, ok +} + +func (p *CreateNetworkOfferingParams) SetRoutingmode(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["routingmode"] = v +} + +func (p *CreateNetworkOfferingParams) ResetRoutingmode() { + if p.p != nil && p.p["routingmode"] != nil { + delete(p.p, "routingmode") + } +} + +func (p *CreateNetworkOfferingParams) GetRoutingmode() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["routingmode"].(string) + return value, ok +} + func (p *CreateNetworkOfferingParams) SetServicecapabilitylist(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -552,6 +679,27 @@ func (p *CreateNetworkOfferingParams) GetServiceproviderlist() (map[string]strin return value, ok } +func (p *CreateNetworkOfferingParams) SetSpecifyasnumber(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["specifyasnumber"] = v +} + +func (p *CreateNetworkOfferingParams) ResetSpecifyasnumber() { + if p.p != nil && p.p["specifyasnumber"] != nil { + delete(p.p, "specifyasnumber") + } +} + +func (p *CreateNetworkOfferingParams) GetSpecifyasnumber() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["specifyasnumber"].(bool) + return value, ok +} + func (p *CreateNetworkOfferingParams) SetSpecifyipranges(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -718,6 +866,7 @@ type CreateNetworkOfferingResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` + Fornsx bool `json:"fornsx"` Fortungsten bool `json:"fortungsten"` Forvpc bool `json:"forvpc"` Guestiptype string `json:"guestiptype"` @@ -730,12 +879,16 @@ type CreateNetworkOfferingResponse struct { Jobstatus int `json:"jobstatus"` Maxconnections int `json:"maxconnections"` Name string `json:"name"` + Networkmode string `json:"networkmode"` Networkrate int `json:"networkrate"` + Routingmode string `json:"routingmode"` Service []CreateNetworkOfferingResponseService `json:"service"` Serviceofferingid string `json:"serviceofferingid"` + Specifyasnumber bool `json:"specifyasnumber"` Specifyipranges bool `json:"specifyipranges"` Specifyvlan bool `json:"specifyvlan"` State string `json:"state"` + Supportsinternallb bool `json:"supportsinternallb"` Supportspublicaccess bool `json:"supportspublicaccess"` Supportsstrechedl2subnet bool `json:"supportsstrechedl2subnet"` Tags string `json:"tags"` @@ -913,6 +1066,9 @@ func (p *ListNetworkOfferingsParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("pagesize", vv) } + if v, found := p.p["routingmode"]; found { + u.Set("routingmode", v.(string)) + } if v, found := p.p["sourcenatsupported"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("sourcenatsupported", vv) @@ -1217,6 +1373,27 @@ func (p *ListNetworkOfferingsParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListNetworkOfferingsParams) SetRoutingmode(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["routingmode"] = v +} + +func (p *ListNetworkOfferingsParams) ResetRoutingmode() { + if p.p != nil && p.p["routingmode"] != nil { + delete(p.p, "routingmode") + } +} + +func (p *ListNetworkOfferingsParams) GetRoutingmode() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["routingmode"].(string) + return value, ok +} + func (p *ListNetworkOfferingsParams) SetSourcenatsupported(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1505,6 +1682,7 @@ type NetworkOffering struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` + Fornsx bool `json:"fornsx"` Fortungsten bool `json:"fortungsten"` Forvpc bool `json:"forvpc"` Guestiptype string `json:"guestiptype"` @@ -1517,12 +1695,16 @@ type NetworkOffering struct { Jobstatus int `json:"jobstatus"` Maxconnections int `json:"maxconnections"` Name string `json:"name"` + Networkmode string `json:"networkmode"` Networkrate int `json:"networkrate"` + Routingmode string `json:"routingmode"` Service []NetworkOfferingServiceInternal `json:"service"` Serviceofferingid string `json:"serviceofferingid"` + Specifyasnumber bool `json:"specifyasnumber"` Specifyipranges bool `json:"specifyipranges"` Specifyvlan bool `json:"specifyvlan"` State string `json:"state"` + Supportsinternallb bool `json:"supportsinternallb"` Supportspublicaccess bool `json:"supportspublicaccess"` Supportsstrechedl2subnet bool `json:"supportsstrechedl2subnet"` Tags string `json:"tags"` @@ -1868,6 +2050,7 @@ type UpdateNetworkOfferingResponse struct { Domain string `json:"domain"` Domainid string `json:"domainid"` Egressdefaultpolicy bool `json:"egressdefaultpolicy"` + Fornsx bool `json:"fornsx"` Fortungsten bool `json:"fortungsten"` Forvpc bool `json:"forvpc"` Guestiptype string `json:"guestiptype"` @@ -1880,12 +2063,16 @@ type UpdateNetworkOfferingResponse struct { Jobstatus int `json:"jobstatus"` Maxconnections int `json:"maxconnections"` Name string `json:"name"` + Networkmode string `json:"networkmode"` Networkrate int `json:"networkrate"` + Routingmode string `json:"routingmode"` Service []UpdateNetworkOfferingResponseService `json:"service"` Serviceofferingid string `json:"serviceofferingid"` + Specifyasnumber bool `json:"specifyasnumber"` Specifyipranges bool `json:"specifyipranges"` Specifyvlan bool `json:"specifyvlan"` State string `json:"state"` + Supportsinternallb bool `json:"supportsinternallb"` Supportspublicaccess bool `json:"supportspublicaccess"` Supportsstrechedl2subnet bool `json:"supportsstrechedl2subnet"` Tags string `json:"tags"` diff --git a/cloudstack/NetworkService.go b/cloudstack/NetworkService.go index 847ecfeb..93dcc8de 100644 --- a/cloudstack/NetworkService.go +++ b/cloudstack/NetworkService.go @@ -462,13 +462,25 @@ func (p *CreateNetworkParams) toURLValues() url.Values { if v, found := p.p["acltype"]; found { u.Set("acltype", v.(string)) } + if v, found := p.p["asnumber"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("asnumber", vv) + } if v, found := p.p["associatednetworkid"]; found { u.Set("associatednetworkid", v.(string)) } + if v, found := p.p["bgppeerids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("bgppeerids", vv) + } if v, found := p.p["bypassvlanoverlapcheck"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("bypassvlanoverlapcheck", vv) } + if v, found := p.p["cidrsize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("cidrsize", vv) + } if v, found := p.p["displaynetwork"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("displaynetwork", vv) @@ -642,6 +654,27 @@ func (p *CreateNetworkParams) GetAcltype() (string, bool) { return value, ok } +func (p *CreateNetworkParams) SetAsnumber(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["asnumber"] = v +} + +func (p *CreateNetworkParams) ResetAsnumber() { + if p.p != nil && p.p["asnumber"] != nil { + delete(p.p, "asnumber") + } +} + +func (p *CreateNetworkParams) GetAsnumber() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["asnumber"].(int64) + return value, ok +} + func (p *CreateNetworkParams) SetAssociatednetworkid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -663,6 +696,27 @@ func (p *CreateNetworkParams) GetAssociatednetworkid() (string, bool) { return value, ok } +func (p *CreateNetworkParams) SetBgppeerids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["bgppeerids"] = v +} + +func (p *CreateNetworkParams) ResetBgppeerids() { + if p.p != nil && p.p["bgppeerids"] != nil { + delete(p.p, "bgppeerids") + } +} + +func (p *CreateNetworkParams) GetBgppeerids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["bgppeerids"].([]string) + return value, ok +} + func (p *CreateNetworkParams) SetBypassvlanoverlapcheck(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -684,6 +738,27 @@ func (p *CreateNetworkParams) GetBypassvlanoverlapcheck() (bool, bool) { return value, ok } +func (p *CreateNetworkParams) SetCidrsize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cidrsize"] = v +} + +func (p *CreateNetworkParams) ResetCidrsize() { + if p.p != nil && p.p["cidrsize"] != nil { + delete(p.p, "cidrsize") + } +} + +func (p *CreateNetworkParams) GetCidrsize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cidrsize"].(int) + return value, ok +} + func (p *CreateNetworkParams) SetDisplaynetwork(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1433,8 +1508,11 @@ type CreateNetworkResponse struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Asnumber int64 `json:"asnumber"` + Asnumberid string `json:"asnumberid"` Associatednetwork string `json:"associatednetwork"` Associatednetworkid string `json:"associatednetworkid"` + Bgppeers []interface{} `json:"bgppeers"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -1455,6 +1533,8 @@ type CreateNetworkResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` + Ip4routes []interface{} `json:"ip4routes"` + Ip4routing string `json:"ip4routing"` Ip6cidr string `json:"ip6cidr"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` @@ -2075,6 +2155,7 @@ type CreateServiceInstanceResponse struct { Displayname string `json:"displayname"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` @@ -2440,8 +2521,10 @@ type DedicatePublicIpRangeResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Endip string `json:"endip"` Endipv6 string `json:"endipv6"` + Fornsx bool `json:"fornsx"` Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Gateway string `json:"gateway"` @@ -3087,8 +3170,11 @@ type NetscalerLoadBalancerNetwork struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Asnumber int64 `json:"asnumber"` + Asnumberid string `json:"asnumberid"` Associatednetwork string `json:"associatednetwork"` Associatednetworkid string `json:"associatednetworkid"` + Bgppeers []interface{} `json:"bgppeers"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -3109,6 +3195,8 @@ type NetscalerLoadBalancerNetwork struct { Icon interface{} `json:"icon"` Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` + Ip4routes []interface{} `json:"ip4routes"` + Ip4routing string `json:"ip4routing"` Ip6cidr string `json:"ip6cidr"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` @@ -4375,8 +4463,11 @@ type Network struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Asnumber int64 `json:"asnumber"` + Asnumberid string `json:"asnumberid"` Associatednetwork string `json:"associatednetwork"` Associatednetworkid string `json:"associatednetworkid"` + Bgppeers []interface{} `json:"bgppeers"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -4397,6 +4488,8 @@ type Network struct { Icon interface{} `json:"icon"` Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` + Ip4routes []interface{} `json:"ip4routes"` + Ip4routing string `json:"ip4routing"` Ip6cidr string `json:"ip6cidr"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` @@ -4649,8 +4742,11 @@ type NiciraNvpDeviceNetwork struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Asnumber int64 `json:"asnumber"` + Asnumberid string `json:"asnumberid"` Associatednetwork string `json:"associatednetwork"` Associatednetworkid string `json:"associatednetworkid"` + Bgppeers []interface{} `json:"bgppeers"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -4671,6 +4767,8 @@ type NiciraNvpDeviceNetwork struct { Icon interface{} `json:"icon"` Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` + Ip4routes []interface{} `json:"ip4routes"` + Ip4routing string `json:"ip4routing"` Ip6cidr string `json:"ip6cidr"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` @@ -5054,8 +5152,11 @@ type PaloAltoFirewallNetwork struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Asnumber int64 `json:"asnumber"` + Asnumberid string `json:"asnumberid"` Associatednetwork string `json:"associatednetwork"` Associatednetworkid string `json:"associatednetworkid"` + Bgppeers []interface{} `json:"bgppeers"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -5076,6 +5177,8 @@ type PaloAltoFirewallNetwork struct { Icon interface{} `json:"icon"` Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` + Ip4routes []interface{} `json:"ip4routes"` + Ip4routing string `json:"ip4routing"` Ip6cidr string `json:"ip6cidr"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` @@ -6626,8 +6729,11 @@ type UpdateNetworkResponse struct { Aclid string `json:"aclid"` Aclname string `json:"aclname"` Acltype string `json:"acltype"` + Asnumber int64 `json:"asnumber"` + Asnumberid string `json:"asnumberid"` Associatednetwork string `json:"associatednetwork"` Associatednetworkid string `json:"associatednetworkid"` + Bgppeers []interface{} `json:"bgppeers"` Broadcastdomaintype string `json:"broadcastdomaintype"` Broadcasturi string `json:"broadcasturi"` Canusefordeploy bool `json:"canusefordeploy"` @@ -6648,6 +6754,8 @@ type UpdateNetworkResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` + Ip4routes []interface{} `json:"ip4routes"` + Ip4routing string `json:"ip4routing"` Ip6cidr string `json:"ip6cidr"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` diff --git a/cloudstack/NicService.go b/cloudstack/NicService.go index 8147f716..23a48b33 100644 --- a/cloudstack/NicService.go +++ b/cloudstack/NicService.go @@ -604,6 +604,7 @@ type UpdateVmNicIpResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -615,6 +616,7 @@ type UpdateVmNicIpResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -628,6 +630,7 @@ type UpdateVmNicIpResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -665,6 +668,7 @@ type UpdateVmNicIpResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -676,6 +680,7 @@ type UpdateVmNicIpResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -687,6 +692,7 @@ type UpdateVmNicIpResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []UpdateVmNicIpResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []UpdateVmNicIpResponseSecuritygroupRule `json:"ingressrule"` @@ -712,16 +718,18 @@ type UpdateVmNicIpResponseSecuritygroupRule struct { } type UpdateVmNicIpResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *UpdateVmNicIpResponse) UnmarshalJSON(b []byte) error { diff --git a/cloudstack/OvsElementService.go b/cloudstack/OvsElementService.go index 88d9c27e..335a1750 100644 --- a/cloudstack/OvsElementService.go +++ b/cloudstack/OvsElementService.go @@ -142,16 +142,17 @@ func (s *OvsElementService) ConfigureOvsElement(p *ConfigureOvsElementParams) (* } type OvsElementResponse struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Enabled bool `json:"enabled"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Nspid string `json:"nspid"` - Project string `json:"project"` - Projectid string `json:"projectid"` + Account string `json:"account"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Enabled bool `json:"enabled"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Nspid string `json:"nspid"` + Project string `json:"project"` + Projectid string `json:"projectid"` } type ListOvsElementsParams struct { @@ -375,14 +376,15 @@ type ListOvsElementsResponse struct { } type OvsElement struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Enabled bool `json:"enabled"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Nspid string `json:"nspid"` - Project string `json:"project"` - Projectid string `json:"projectid"` + Account string `json:"account"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Enabled bool `json:"enabled"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Nspid string `json:"nspid"` + Project string `json:"project"` + Projectid string `json:"projectid"` } diff --git a/cloudstack/PodService.go b/cloudstack/PodService.go index 34f70f80..104571c9 100644 --- a/cloudstack/PodService.go +++ b/cloudstack/PodService.go @@ -294,6 +294,7 @@ type CreatePodResponseCapacity struct { Percentused string `json:"percentused"` Podid string `json:"podid"` Podname string `json:"podname"` + Tag string `json:"tag"` Type int `json:"type"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` @@ -1110,6 +1111,7 @@ type PodCapacity struct { Percentused string `json:"percentused"` Podid string `json:"podid"` Podname string `json:"podname"` + Tag string `json:"tag"` Type int `json:"type"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` @@ -1439,6 +1441,7 @@ type UpdatePodResponseCapacity struct { Percentused string `json:"percentused"` Podid string `json:"podid"` Podname string `json:"podname"` + Tag string `json:"tag"` Type int `json:"type"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` diff --git a/cloudstack/PoolService.go b/cloudstack/PoolService.go index b2f7f1d9..1f115edc 100644 --- a/cloudstack/PoolService.go +++ b/cloudstack/PoolService.go @@ -446,7 +446,9 @@ type CreateStoragePoolResponse struct { Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Managed bool `json:"managed"` Name string `json:"name"` + Nfsmountopts string `json:"nfsmountopts"` Overprovisionfactor string `json:"overprovisionfactor"` Path string `json:"path"` Podid string `json:"podid"` @@ -455,6 +457,7 @@ type CreateStoragePoolResponse struct { Scope string `json:"scope"` State string `json:"state"` Storagecapabilities map[string]string `json:"storagecapabilities"` + Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` @@ -731,7 +734,9 @@ type FindStoragePoolsForMigrationResponse struct { Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Managed bool `json:"managed"` Name string `json:"name"` + Nfsmountopts string `json:"nfsmountopts"` Overprovisionfactor string `json:"overprovisionfactor"` Path string `json:"path"` Podid string `json:"podid"` @@ -740,6 +745,7 @@ type FindStoragePoolsForMigrationResponse struct { Scope string `json:"scope"` State string `json:"state"` Storagecapabilities map[string]string `json:"storagecapabilities"` + Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` @@ -794,6 +800,10 @@ func (p *ListStoragePoolsParams) toURLValues() url.Values { if v, found := p.p["status"]; found { u.Set("status", v.(string)) } + if v, found := p.p["storagecustomstats"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("storagecustomstats", vv) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -1052,6 +1062,27 @@ func (p *ListStoragePoolsParams) GetStatus() (string, bool) { return value, ok } +func (p *ListStoragePoolsParams) SetStoragecustomstats(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["storagecustomstats"] = v +} + +func (p *ListStoragePoolsParams) ResetStoragecustomstats() { + if p.p != nil && p.p["storagecustomstats"] != nil { + delete(p.p, "storagecustomstats") + } +} + +func (p *ListStoragePoolsParams) GetStoragecustomstats() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["storagecustomstats"].(bool) + return value, ok +} + func (p *ListStoragePoolsParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1200,7 +1231,9 @@ type StoragePool struct { Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Managed bool `json:"managed"` Name string `json:"name"` + Nfsmountopts string `json:"nfsmountopts"` Overprovisionfactor string `json:"overprovisionfactor"` Path string `json:"path"` Podid string `json:"podid"` @@ -1209,6 +1242,7 @@ type StoragePool struct { Scope string `json:"scope"` State string `json:"state"` Storagecapabilities map[string]string `json:"storagecapabilities"` + Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` @@ -1312,7 +1346,9 @@ type SyncStoragePoolResponse struct { Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Managed bool `json:"managed"` Name string `json:"name"` + Nfsmountopts string `json:"nfsmountopts"` Overprovisionfactor string `json:"overprovisionfactor"` Path string `json:"path"` Podid string `json:"podid"` @@ -1321,6 +1357,7 @@ type SyncStoragePoolResponse struct { Scope string `json:"scope"` State string `json:"state"` Storagecapabilities map[string]string `json:"storagecapabilities"` + Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` @@ -1604,7 +1641,9 @@ type UpdateStoragePoolResponse struct { Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Managed bool `json:"managed"` Name string `json:"name"` + Nfsmountopts string `json:"nfsmountopts"` Overprovisionfactor string `json:"overprovisionfactor"` Path string `json:"path"` Podid string `json:"podid"` @@ -1613,6 +1652,7 @@ type UpdateStoragePoolResponse struct { Scope string `json:"scope"` State string `json:"state"` Storagecapabilities map[string]string `json:"storagecapabilities"` + Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` diff --git a/cloudstack/ProjectService.go b/cloudstack/ProjectService.go index c395376a..373065e3 100644 --- a/cloudstack/ProjectService.go +++ b/cloudstack/ProjectService.go @@ -182,6 +182,7 @@ type ActivateProjectResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Tags []Tags `json:"tags"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` @@ -791,6 +792,7 @@ type CreateProjectResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Tags []Tags `json:"tags"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` @@ -1578,17 +1580,18 @@ type ListProjectInvitationsResponse struct { } type ProjectInvitation struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Email string `json:"email"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Project string `json:"project"` - Projectid string `json:"projectid"` - State string `json:"state"` - Userid string `json:"userid"` + Account string `json:"account"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Email string `json:"email"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Project string `json:"project"` + Projectid string `json:"projectid"` + State string `json:"state"` + Userid string `json:"userid"` } type ListProjectsParams struct { @@ -2118,6 +2121,7 @@ type Project struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Tags []Tags `json:"tags"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` @@ -2249,6 +2253,7 @@ type SuspendProjectResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Tags []Tags `json:"tags"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` @@ -2525,6 +2530,7 @@ type UpdateProjectResponse struct { Snapshotlimit string `json:"snapshotlimit"` Snapshottotal int64 `json:"snapshottotal"` State string `json:"state"` + Taggedresources []string `json:"taggedresources"` Tags []Tags `json:"tags"` Templateavailable string `json:"templateavailable"` Templatelimit string `json:"templatelimit"` diff --git a/cloudstack/ResourcemetadataService.go b/cloudstack/ResourcemetadataService.go index 7be87ad3..0e3262ee 100644 --- a/cloudstack/ResourcemetadataService.go +++ b/cloudstack/ResourcemetadataService.go @@ -627,6 +627,7 @@ type ResourceDetail struct { Customer string `json:"customer"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Key string `json:"key"` diff --git a/cloudstack/ResourcetagsService.go b/cloudstack/ResourcetagsService.go index 51e2505b..bd49f0b8 100644 --- a/cloudstack/ResourcetagsService.go +++ b/cloudstack/ResourcetagsService.go @@ -857,6 +857,7 @@ type Tag struct { Customer string `json:"customer"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Key string `json:"key"` diff --git a/cloudstack/RoleService.go b/cloudstack/RoleService.go index d3d2cf2e..e9704aa3 100644 --- a/cloudstack/RoleService.go +++ b/cloudstack/RoleService.go @@ -219,6 +219,7 @@ type CreateRoleResponse struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` + State string `json:"state"` Type string `json:"type"` } @@ -753,6 +754,7 @@ type ImportRoleResponse struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` + State string `json:"state"` Type string `json:"type"` } @@ -857,6 +859,9 @@ func (p *ListRolesParams) toURLValues() url.Values { vv := strconv.Itoa(v.(int)) u.Set("pagesize", vv) } + if v, found := p.p["state"]; found { + u.Set("state", v.(string)) + } if v, found := p.p["type"]; found { u.Set("type", v.(string)) } @@ -968,6 +973,27 @@ func (p *ListRolesParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListRolesParams) SetState(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["state"] = v +} + +func (p *ListRolesParams) ResetState() { + if p.p != nil && p.p["state"] != nil { + delete(p.p, "state") + } +} + +func (p *ListRolesParams) GetState() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["state"].(string) + return value, ok +} + func (p *ListRolesParams) SetType(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1108,6 +1134,7 @@ type Role struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` + State string `json:"state"` Type string `json:"type"` } @@ -1279,6 +1306,7 @@ type UpdateRoleResponse struct { JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` + State string `json:"state"` Type string `json:"type"` } diff --git a/cloudstack/RouterService.go b/cloudstack/RouterService.go index 4a9162bc..d964cf5c 100644 --- a/cloudstack/RouterService.go +++ b/cloudstack/RouterService.go @@ -144,6 +144,7 @@ type ChangeServiceForRouterResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gateway string `json:"gateway"` Guestipaddress string `json:"guestipaddress"` Guestmacaddress string `json:"guestmacaddress"` @@ -310,16 +311,17 @@ func (s *RouterService) ConfigureVirtualRouterElement(p *ConfigureVirtualRouterE } type VirtualRouterElementResponse struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Enabled bool `json:"enabled"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Nspid string `json:"nspid"` - Project string `json:"project"` - Projectid string `json:"projectid"` + Account string `json:"account"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Enabled bool `json:"enabled"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Nspid string `json:"nspid"` + Project string `json:"project"` + Projectid string `json:"projectid"` } type CreateVirtualRouterElementParams struct { @@ -427,16 +429,17 @@ func (s *RouterService) CreateVirtualRouterElement(p *CreateVirtualRouterElement } type CreateVirtualRouterElementResponse struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Enabled bool `json:"enabled"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Nspid string `json:"nspid"` - Project string `json:"project"` - Projectid string `json:"projectid"` + Account string `json:"account"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Enabled bool `json:"enabled"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Nspid string `json:"nspid"` + Project string `json:"project"` + Projectid string `json:"projectid"` } type DestroyRouterParams struct { @@ -526,6 +529,7 @@ type DestroyRouterResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gateway string `json:"gateway"` Guestipaddress string `json:"guestipaddress"` Guestmacaddress string `json:"guestmacaddress"` @@ -1226,6 +1230,7 @@ type Router struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gateway string `json:"gateway"` Guestipaddress string `json:"guestipaddress"` Guestmacaddress string `json:"guestmacaddress"` @@ -1506,16 +1511,17 @@ type ListVirtualRouterElementsResponse struct { } type VirtualRouterElement struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Enabled bool `json:"enabled"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Nspid string `json:"nspid"` - Project string `json:"project"` - Projectid string `json:"projectid"` + Account string `json:"account"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Enabled bool `json:"enabled"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Nspid string `json:"nspid"` + Project string `json:"project"` + Projectid string `json:"projectid"` } type RebootRouterParams struct { @@ -1630,6 +1636,7 @@ type RebootRouterResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gateway string `json:"gateway"` Guestipaddress string `json:"guestipaddress"` Guestmacaddress string `json:"guestmacaddress"` @@ -1776,6 +1783,7 @@ type StartRouterResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gateway string `json:"gateway"` Guestipaddress string `json:"guestipaddress"` Guestmacaddress string `json:"guestmacaddress"` @@ -1947,6 +1955,7 @@ type StopRouterResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gateway string `json:"gateway"` Guestipaddress string `json:"guestipaddress"` Guestmacaddress string `json:"guestmacaddress"` diff --git a/cloudstack/SSHService.go b/cloudstack/SSHService.go index 6d48625b..253fb8fe 100644 --- a/cloudstack/SSHService.go +++ b/cloudstack/SSHService.go @@ -1154,6 +1154,7 @@ type ResetSSHKeyForVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -1165,6 +1166,7 @@ type ResetSSHKeyForVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -1178,6 +1180,7 @@ type ResetSSHKeyForVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -1215,6 +1218,7 @@ type ResetSSHKeyForVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -1226,6 +1230,7 @@ type ResetSSHKeyForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -1237,6 +1242,7 @@ type ResetSSHKeyForVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []ResetSSHKeyForVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []ResetSSHKeyForVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -1262,16 +1268,18 @@ type ResetSSHKeyForVirtualMachineResponseSecuritygroupRule struct { } type ResetSSHKeyForVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *ResetSSHKeyForVirtualMachineResponse) UnmarshalJSON(b []byte) error { diff --git a/cloudstack/SecurityGroupService.go b/cloudstack/SecurityGroupService.go index ad30d5c0..dcc09d0b 100644 --- a/cloudstack/SecurityGroupService.go +++ b/cloudstack/SecurityGroupService.go @@ -988,6 +988,7 @@ type CreateSecurityGroupResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []CreateSecurityGroupResponseRule `json:"egressrule"` Id string `json:"id"` Ingressrule []CreateSecurityGroupResponseRule `json:"ingressrule"` @@ -1627,6 +1628,7 @@ type SecurityGroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []SecurityGroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []SecurityGroupRule `json:"ingressrule"` diff --git a/cloudstack/ServiceOfferingService.go b/cloudstack/ServiceOfferingService.go index 33c06da7..b6f54519 100644 --- a/cloudstack/ServiceOfferingService.go +++ b/cloudstack/ServiceOfferingService.go @@ -203,6 +203,10 @@ func (p *CreateServiceOfferingParams) toURLValues() url.Values { if v, found := p.p["provisioningtype"]; found { u.Set("provisioningtype", v.(string)) } + if v, found := p.p["purgeresources"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("purgeresources", vv) + } if v, found := p.p["rootdisksize"]; found { vv := strconv.FormatInt(v.(int64), 10) u.Set("rootdisksize", vv) @@ -1073,6 +1077,27 @@ func (p *CreateServiceOfferingParams) GetProvisioningtype() (string, bool) { return value, ok } +func (p *CreateServiceOfferingParams) SetPurgeresources(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["purgeresources"] = v +} + +func (p *CreateServiceOfferingParams) ResetPurgeresources() { + if p.p != nil && p.p["purgeresources"] != nil { + delete(p.p, "purgeresources") + } +} + +func (p *CreateServiceOfferingParams) GetPurgeresources() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["purgeresources"].(bool) + return value, ok +} + func (p *CreateServiceOfferingParams) SetRootdisksize(v int64) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1295,8 +1320,10 @@ type CreateServiceOfferingResponse struct { Networkrate int `json:"networkrate"` Offerha bool `json:"offerha"` Provisioningtype string `json:"provisioningtype"` + Purgeresources bool `json:"purgeresources"` Rootdisksize int64 `json:"rootdisksize"` Serviceofferingdetails map[string]string `json:"serviceofferingdetails"` + State string `json:"state"` Storagetags string `json:"storagetags"` Storagetype string `json:"storagetype"` Systemvmtype string `json:"systemvmtype"` @@ -1462,12 +1489,18 @@ func (p *ListServiceOfferingsParams) toURLValues() url.Values { if v, found := p.p["projectid"]; found { u.Set("projectid", v.(string)) } + if v, found := p.p["state"]; found { + u.Set("state", v.(string)) + } if v, found := p.p["storagetype"]; found { u.Set("storagetype", v.(string)) } if v, found := p.p["systemvmtype"]; found { u.Set("systemvmtype", v.(string)) } + if v, found := p.p["templateid"]; found { + u.Set("templateid", v.(string)) + } if v, found := p.p["virtualmachineid"]; found { u.Set("virtualmachineid", v.(string)) } @@ -1792,6 +1825,27 @@ func (p *ListServiceOfferingsParams) GetProjectid() (string, bool) { return value, ok } +func (p *ListServiceOfferingsParams) SetState(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["state"] = v +} + +func (p *ListServiceOfferingsParams) ResetState() { + if p.p != nil && p.p["state"] != nil { + delete(p.p, "state") + } +} + +func (p *ListServiceOfferingsParams) GetState() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["state"].(string) + return value, ok +} + func (p *ListServiceOfferingsParams) SetStoragetype(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1834,6 +1888,27 @@ func (p *ListServiceOfferingsParams) GetSystemvmtype() (string, bool) { return value, ok } +func (p *ListServiceOfferingsParams) SetTemplateid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["templateid"] = v +} + +func (p *ListServiceOfferingsParams) ResetTemplateid() { + if p.p != nil && p.p["templateid"] != nil { + delete(p.p, "templateid") + } +} + +func (p *ListServiceOfferingsParams) GetTemplateid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["templateid"].(string) + return value, ok +} + func (p *ListServiceOfferingsParams) SetVirtualmachineid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2033,8 +2108,10 @@ type ServiceOffering struct { Networkrate int `json:"networkrate"` Offerha bool `json:"offerha"` Provisioningtype string `json:"provisioningtype"` + Purgeresources bool `json:"purgeresources"` Rootdisksize int64 `json:"rootdisksize"` Serviceofferingdetails map[string]string `json:"serviceofferingdetails"` + State string `json:"state"` Storagetags string `json:"storagetags"` Storagetype string `json:"storagetype"` Systemvmtype string `json:"systemvmtype"` @@ -2067,10 +2144,17 @@ func (p *UpdateServiceOfferingParams) toURLValues() url.Values { if v, found := p.p["name"]; found { u.Set("name", v.(string)) } + if v, found := p.p["purgeresources"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("purgeresources", vv) + } if v, found := p.p["sortkey"]; found { vv := strconv.Itoa(v.(int)) u.Set("sortkey", vv) } + if v, found := p.p["state"]; found { + u.Set("state", v.(string)) + } if v, found := p.p["storagetags"]; found { u.Set("storagetags", v.(string)) } @@ -2185,6 +2269,27 @@ func (p *UpdateServiceOfferingParams) GetName() (string, bool) { return value, ok } +func (p *UpdateServiceOfferingParams) SetPurgeresources(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["purgeresources"] = v +} + +func (p *UpdateServiceOfferingParams) ResetPurgeresources() { + if p.p != nil && p.p["purgeresources"] != nil { + delete(p.p, "purgeresources") + } +} + +func (p *UpdateServiceOfferingParams) GetPurgeresources() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["purgeresources"].(bool) + return value, ok +} + func (p *UpdateServiceOfferingParams) SetSortkey(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2206,6 +2311,27 @@ func (p *UpdateServiceOfferingParams) GetSortkey() (int, bool) { return value, ok } +func (p *UpdateServiceOfferingParams) SetState(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["state"] = v +} + +func (p *UpdateServiceOfferingParams) ResetState() { + if p.p != nil && p.p["state"] != nil { + delete(p.p, "state") + } +} + +func (p *UpdateServiceOfferingParams) GetState() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["state"].(string) + return value, ok +} + func (p *UpdateServiceOfferingParams) SetStoragetags(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2322,8 +2448,10 @@ type UpdateServiceOfferingResponse struct { Networkrate int `json:"networkrate"` Offerha bool `json:"offerha"` Provisioningtype string `json:"provisioningtype"` + Purgeresources bool `json:"purgeresources"` Rootdisksize int64 `json:"rootdisksize"` Serviceofferingdetails map[string]string `json:"serviceofferingdetails"` + State string `json:"state"` Storagetags string `json:"storagetags"` Storagetype string `json:"storagetype"` Systemvmtype string `json:"systemvmtype"` diff --git a/cloudstack/SnapshotService.go b/cloudstack/SnapshotService.go index c17334b6..bc684030 100644 --- a/cloudstack/SnapshotService.go +++ b/cloudstack/SnapshotService.go @@ -371,6 +371,7 @@ type CreateSnapshotResponse struct { Datastoretype string `json:"datastoretype"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails map[string]string `json:"downloaddetails"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -392,6 +393,7 @@ type CreateSnapshotResponse struct { Virtualsize int64 `json:"virtualsize"` Volumeid string `json:"volumeid"` Volumename string `json:"volumename"` + Volumestate string `json:"volumestate"` Volumetype string `json:"volumetype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` @@ -864,6 +866,7 @@ type CreateVMSnapshotResponse struct { Displayname string `json:"displayname"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` @@ -2046,6 +2049,7 @@ type Snapshot struct { Datastoretype string `json:"datastoretype"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails map[string]string `json:"downloaddetails"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -2067,6 +2071,7 @@ type Snapshot struct { Virtualsize int64 `json:"virtualsize"` Volumeid string `json:"volumeid"` Volumename string `json:"volumename"` + Volumestate string `json:"volumestate"` Volumetype string `json:"volumetype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` @@ -2528,6 +2533,7 @@ type VMSnapshot struct { Displayname string `json:"displayname"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Hasannotations bool `json:"hasannotations"` Hypervisor string `json:"hypervisor"` Id string `json:"id"` @@ -2636,6 +2642,7 @@ type RevertSnapshotResponse struct { Datastoretype string `json:"datastoretype"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails map[string]string `json:"downloaddetails"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -2657,6 +2664,7 @@ type RevertSnapshotResponse struct { Virtualsize int64 `json:"virtualsize"` Volumeid string `json:"volumeid"` Volumename string `json:"volumename"` + Volumestate string `json:"volumestate"` Volumetype string `json:"volumetype"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` @@ -2782,6 +2790,7 @@ type RevertToVMSnapshotResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -2793,6 +2802,7 @@ type RevertToVMSnapshotResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -2806,6 +2816,7 @@ type RevertToVMSnapshotResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -2843,6 +2854,7 @@ type RevertToVMSnapshotResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -2854,6 +2866,7 @@ type RevertToVMSnapshotResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -2865,6 +2878,7 @@ type RevertToVMSnapshotResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []RevertToVMSnapshotResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []RevertToVMSnapshotResponseSecuritygroupRule `json:"ingressrule"` @@ -2890,16 +2904,18 @@ type RevertToVMSnapshotResponseSecuritygroupRule struct { } type RevertToVMSnapshotResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *RevertToVMSnapshotResponse) UnmarshalJSON(b []byte) error { diff --git a/cloudstack/StoragePoolService.go b/cloudstack/StoragePoolService.go index dd449858..96231952 100644 --- a/cloudstack/StoragePoolService.go +++ b/cloudstack/StoragePoolService.go @@ -130,7 +130,9 @@ type CancelStorageMaintenanceResponse struct { Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Managed bool `json:"managed"` Name string `json:"name"` + Nfsmountopts string `json:"nfsmountopts"` Overprovisionfactor string `json:"overprovisionfactor"` Path string `json:"path"` Podid string `json:"podid"` @@ -139,6 +141,7 @@ type CancelStorageMaintenanceResponse struct { Scope string `json:"scope"` State string `json:"state"` Storagecapabilities map[string]string `json:"storagecapabilities"` + Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` @@ -242,7 +245,9 @@ type EnableStorageMaintenanceResponse struct { Istagarule bool `json:"istagarule"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` + Managed bool `json:"managed"` Name string `json:"name"` + Nfsmountopts string `json:"nfsmountopts"` Overprovisionfactor string `json:"overprovisionfactor"` Path string `json:"path"` Podid string `json:"podid"` @@ -251,6 +256,7 @@ type EnableStorageMaintenanceResponse struct { Scope string `json:"scope"` State string `json:"state"` Storagecapabilities map[string]string `json:"storagecapabilities"` + Storagecustomstats map[string]string `json:"storagecustomstats"` Suitableformigration bool `json:"suitableformigration"` Tags string `json:"tags"` Type string `json:"type"` diff --git a/cloudstack/SystemCapacityService.go b/cloudstack/SystemCapacityService.go index ac63ea3e..1e815cf0 100644 --- a/cloudstack/SystemCapacityService.go +++ b/cloudstack/SystemCapacityService.go @@ -63,6 +63,9 @@ func (p *ListCapacityParams) toURLValues() url.Values { if v, found := p.p["sortby"]; found { u.Set("sortby", v.(string)) } + if v, found := p.p["tag"]; found { + u.Set("tag", v.(string)) + } if v, found := p.p["type"]; found { vv := strconv.Itoa(v.(int)) u.Set("type", vv) @@ -220,6 +223,27 @@ func (p *ListCapacityParams) GetSortby() (string, bool) { return value, ok } +func (p *ListCapacityParams) SetTag(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["tag"] = v +} + +func (p *ListCapacityParams) ResetTag() { + if p.p != nil && p.p["tag"] != nil { + delete(p.p, "tag") + } +} + +func (p *ListCapacityParams) GetTag() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["tag"].(string) + return value, ok +} + func (p *ListCapacityParams) SetType(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -302,6 +326,7 @@ type Capacity struct { Percentused string `json:"percentused"` Podid string `json:"podid"` Podname string `json:"podname"` + Tag string `json:"tag"` Type int `json:"type"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` diff --git a/cloudstack/TemplateService.go b/cloudstack/TemplateService.go index dd4edf2b..bb3a9ae4 100644 --- a/cloudstack/TemplateService.go +++ b/cloudstack/TemplateService.go @@ -219,6 +219,7 @@ func (s *TemplateService) CopyTemplate(p *CopyTemplateParams) (*CopyTemplateResp type CopyTemplateResponse struct { Account string `json:"account"` Accountid string `json:"accountid"` + Arch string `json:"arch"` Bits int `json:"bits"` Bootable bool `json:"bootable"` Checksum string `json:"checksum"` @@ -232,6 +233,7 @@ type CopyTemplateResponse struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` @@ -851,6 +853,7 @@ func (s *TemplateService) CreateTemplate(p *CreateTemplateParams) (*CreateTempla type CreateTemplateResponse struct { Account string `json:"account"` Accountid string `json:"accountid"` + Arch string `json:"arch"` Bits int `json:"bits"` Bootable bool `json:"bootable"` Checksum string `json:"checksum"` @@ -864,6 +867,7 @@ type CreateTemplateResponse struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` @@ -948,6 +952,10 @@ func (p *DeleteTemplateParams) toURLValues() url.Values { if v, found := p.p["id"]; found { u.Set("id", v.(string)) } + if v, found := p.p["issystem"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("issystem", vv) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -996,6 +1004,27 @@ func (p *DeleteTemplateParams) GetId() (string, bool) { return value, ok } +func (p *DeleteTemplateParams) SetIssystem(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["issystem"] = v +} + +func (p *DeleteTemplateParams) ResetIssystem() { + if p.p != nil && p.p["issystem"] != nil { + delete(p.p, "issystem") + } +} + +func (p *DeleteTemplateParams) GetIssystem() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["issystem"].(bool) + return value, ok +} + func (p *DeleteTemplateParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1247,6 +1276,9 @@ func (p *GetUploadParamsForTemplateParams) toURLValues() url.Values { if v, found := p.p["account"]; found { u.Set("account", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["bits"]; found { vv := strconv.Itoa(v.(int)) u.Set("bits", vv) @@ -1347,6 +1379,27 @@ func (p *GetUploadParamsForTemplateParams) GetAccount() (string, bool) { return value, ok } +func (p *GetUploadParamsForTemplateParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *GetUploadParamsForTemplateParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *GetUploadParamsForTemplateParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *GetUploadParamsForTemplateParams) SetBits(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1949,6 +2002,9 @@ func (p *ListTemplatesParams) toURLValues() url.Values { if v, found := p.p["account"]; found { u.Set("account", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["details"]; found { vv := strings.Join(v.([]string), ",") u.Set("details", vv) @@ -2056,6 +2112,27 @@ func (p *ListTemplatesParams) GetAccount() (string, bool) { return value, ok } +func (p *ListTemplatesParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *ListTemplatesParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *ListTemplatesParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *ListTemplatesParams) SetDetails(v []string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2657,6 +2734,7 @@ type ListTemplatesResponse struct { type Template struct { Account string `json:"account"` Accountid string `json:"accountid"` + Arch string `json:"arch"` Bits int `json:"bits"` Bootable bool `json:"bootable"` Checksum string `json:"checksum"` @@ -2670,6 +2748,7 @@ type Template struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` @@ -2850,6 +2929,7 @@ func (s *TemplateService) PrepareTemplate(p *PrepareTemplateParams) (*PrepareTem type PrepareTemplateResponse struct { Account string `json:"account"` Accountid string `json:"accountid"` + Arch string `json:"arch"` Bits int `json:"bits"` Bootable bool `json:"bootable"` Checksum string `json:"checksum"` @@ -2863,6 +2943,7 @@ type PrepareTemplateResponse struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` @@ -2943,6 +3024,9 @@ func (p *RegisterTemplateParams) toURLValues() url.Values { if v, found := p.p["account"]; found { u.Set("account", v.(string)) } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["bits"]; found { vv := strconv.Itoa(v.(int)) u.Set("bits", vv) @@ -3057,6 +3141,27 @@ func (p *RegisterTemplateParams) GetAccount() (string, bool) { return value, ok } +func (p *RegisterTemplateParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *RegisterTemplateParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *RegisterTemplateParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *RegisterTemplateParams) SetBits(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3618,6 +3723,7 @@ type RegisterTemplateResponse struct { type RegisterTemplate struct { Account string `json:"account"` Accountid string `json:"accountid"` + Arch string `json:"arch"` Bits int `json:"bits"` Bootable bool `json:"bootable"` Checksum string `json:"checksum"` @@ -3631,6 +3737,7 @@ type RegisterTemplate struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` @@ -3708,6 +3815,9 @@ func (p *UpdateTemplateParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["arch"]; found { + u.Set("arch", v.(string)) + } if v, found := p.p["bootable"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("bootable", vv) @@ -3761,12 +3871,36 @@ func (p *UpdateTemplateParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("sshkeyenabled", vv) } + if v, found := p.p["templatetag"]; found { + u.Set("templatetag", v.(string)) + } if v, found := p.p["templatetype"]; found { u.Set("templatetype", v.(string)) } return u } +func (p *UpdateTemplateParams) SetArch(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["arch"] = v +} + +func (p *UpdateTemplateParams) ResetArch() { + if p.p != nil && p.p["arch"] != nil { + delete(p.p, "arch") + } +} + +func (p *UpdateTemplateParams) GetArch() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["arch"].(string) + return value, ok +} + func (p *UpdateTemplateParams) SetBootable(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4061,6 +4195,27 @@ func (p *UpdateTemplateParams) GetSshkeyenabled() (bool, bool) { return value, ok } +func (p *UpdateTemplateParams) SetTemplatetag(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["templatetag"] = v +} + +func (p *UpdateTemplateParams) ResetTemplatetag() { + if p.p != nil && p.p["templatetag"] != nil { + delete(p.p, "templatetag") + } +} + +func (p *UpdateTemplateParams) GetTemplatetag() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["templatetag"].(string) + return value, ok +} + func (p *UpdateTemplateParams) SetTemplatetype(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4109,6 +4264,7 @@ func (s *TemplateService) UpdateTemplate(p *UpdateTemplateParams) (*UpdateTempla type UpdateTemplateResponse struct { Account string `json:"account"` Accountid string `json:"accountid"` + Arch string `json:"arch"` Bits int `json:"bits"` Bootable bool `json:"bootable"` Checksum string `json:"checksum"` @@ -4122,6 +4278,7 @@ type UpdateTemplateResponse struct { Displaytext string `json:"displaytext"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Downloaddetails []map[string]string `json:"downloaddetails"` Format string `json:"format"` Hasannotations bool `json:"hasannotations"` diff --git a/cloudstack/UsageService.go b/cloudstack/UsageService.go index 86c25a19..e8e7a6ac 100644 --- a/cloudstack/UsageService.go +++ b/cloudstack/UsageService.go @@ -36,7 +36,7 @@ type UsageServiceIface interface { DeleteTrafficType(p *DeleteTrafficTypeParams) (*DeleteTrafficTypeResponse, error) NewDeleteTrafficTypeParams(id string) *DeleteTrafficTypeParams GenerateUsageRecords(p *GenerateUsageRecordsParams) (*GenerateUsageRecordsResponse, error) - NewGenerateUsageRecordsParams(enddate string, startdate string) *GenerateUsageRecordsParams + NewGenerateUsageRecordsParams() *GenerateUsageRecordsParams ListTrafficMonitors(p *ListTrafficMonitorsParams) (*ListTrafficMonitorsResponse, error) NewListTrafficMonitorsParams(zoneid string) *ListTrafficMonitorsParams ListTrafficTypeImplementors(p *ListTrafficTypeImplementorsParams) (*ListTrafficTypeImplementorsResponse, error) @@ -747,11 +747,9 @@ func (p *GenerateUsageRecordsParams) GetStartdate() (string, bool) { // You should always use this function to get a new GenerateUsageRecordsParams instance, // as then you are sure you have configured all required params -func (s *UsageService) NewGenerateUsageRecordsParams(enddate string, startdate string) *GenerateUsageRecordsParams { +func (s *UsageService) NewGenerateUsageRecordsParams() *GenerateUsageRecordsParams { p := &GenerateUsageRecordsParams{} p.p = make(map[string]interface{}) - p.p["enddate"] = enddate - p.p["startdate"] = startdate return p } @@ -1678,6 +1676,7 @@ type UsageRecord struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Enddate string `json:"enddate"` Hasannotations bool `json:"hasannotations"` Isdefault bool `json:"isdefault"` @@ -1779,9 +1778,10 @@ type ListUsageTypesResponse struct { type UsageType struct { Description string `json:"description"` + Id int `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` - Usagetypeid int `json:"usagetypeid"` + Name string `json:"name"` } type RemoveRawUsageRecordsParams struct { diff --git a/cloudstack/UsageService_mock.go b/cloudstack/UsageService_mock.go index 9ff4854d..8b171573 100644 --- a/cloudstack/UsageService_mock.go +++ b/cloudstack/UsageService_mock.go @@ -295,17 +295,17 @@ func (mr *MockUsageServiceIfaceMockRecorder) NewDeleteTrafficTypeParams(id inter } // NewGenerateUsageRecordsParams mocks base method. -func (m *MockUsageServiceIface) NewGenerateUsageRecordsParams(enddate, startdate string) *GenerateUsageRecordsParams { +func (m *MockUsageServiceIface) NewGenerateUsageRecordsParams() *GenerateUsageRecordsParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewGenerateUsageRecordsParams", enddate, startdate) + ret := m.ctrl.Call(m, "NewGenerateUsageRecordsParams") ret0, _ := ret[0].(*GenerateUsageRecordsParams) return ret0 } // NewGenerateUsageRecordsParams indicates an expected call of NewGenerateUsageRecordsParams. -func (mr *MockUsageServiceIfaceMockRecorder) NewGenerateUsageRecordsParams(enddate, startdate interface{}) *gomock.Call { +func (mr *MockUsageServiceIfaceMockRecorder) NewGenerateUsageRecordsParams() *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewGenerateUsageRecordsParams", reflect.TypeOf((*MockUsageServiceIface)(nil).NewGenerateUsageRecordsParams), enddate, startdate) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewGenerateUsageRecordsParams", reflect.TypeOf((*MockUsageServiceIface)(nil).NewGenerateUsageRecordsParams)) } // NewListTrafficMonitorsParams mocks base method. diff --git a/cloudstack/VLANService.go b/cloudstack/VLANService.go index 5f6ddd20..8439665c 100644 --- a/cloudstack/VLANService.go +++ b/cloudstack/VLANService.go @@ -69,6 +69,10 @@ func (p *CreateVlanIpRangeParams) toURLValues() url.Values { if v, found := p.p["endipv6"]; found { u.Set("endipv6", v.(string)) } + if v, found := p.p["fornsx"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("fornsx", vv) + } if v, found := p.p["forsystemvms"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("forsystemvms", vv) @@ -200,6 +204,27 @@ func (p *CreateVlanIpRangeParams) GetEndipv6() (string, bool) { return value, ok } +func (p *CreateVlanIpRangeParams) SetFornsx(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["fornsx"] = v +} + +func (p *CreateVlanIpRangeParams) ResetFornsx() { + if p.p != nil && p.p["fornsx"] != nil { + delete(p.p, "fornsx") + } +} + +func (p *CreateVlanIpRangeParams) GetFornsx() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["fornsx"].(bool) + return value, ok +} + func (p *CreateVlanIpRangeParams) SetForsystemvms(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -527,8 +552,10 @@ type CreateVlanIpRangeResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Endip string `json:"endip"` Endipv6 string `json:"endipv6"` + Fornsx bool `json:"fornsx"` Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Gateway string `json:"gateway"` @@ -715,6 +742,7 @@ type DedicateGuestVlanRangeResponse struct { Account string `json:"account"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Guestvlanrange string `json:"guestvlanrange"` Id string `json:"id"` JobID string `json:"jobid"` @@ -770,7 +798,7 @@ func (s *VLANService) NewDeleteVlanIpRangeParams(id string) *DeleteVlanIpRangePa return p } -// Creates a VLAN IP range. +// Deletes a VLAN IP range. func (s *VLANService) DeleteVlanIpRange(p *DeleteVlanIpRangeParams) (*DeleteVlanIpRangeResponse, error) { resp, err := s.cs.newRequest("deleteVlanIpRange", p.toURLValues()) if err != nil { @@ -1138,6 +1166,7 @@ type DedicatedGuestVlanRange struct { Account string `json:"account"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Guestvlanrange string `json:"guestvlanrange"` Id string `json:"id"` JobID string `json:"jobid"` @@ -1542,8 +1571,10 @@ type VlanIpRange struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Endip string `json:"endip"` Endipv6 string `json:"endipv6"` + Fornsx bool `json:"fornsx"` Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Gateway string `json:"gateway"` @@ -1888,6 +1919,7 @@ type GuestVlan struct { Allocationstate string `json:"allocationstate"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Id int64 `json:"id"` Isdedicated bool `json:"isdedicated"` JobID string `json:"jobid"` @@ -2190,8 +2222,10 @@ type UpdateVlanIpRangeResponse struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Endip string `json:"endip"` Endipv6 string `json:"endipv6"` + Fornsx bool `json:"fornsx"` Forsystemvms bool `json:"forsystemvms"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Gateway string `json:"gateway"` diff --git a/cloudstack/VMGroupService.go b/cloudstack/VMGroupService.go index 9b4b84a3..b2d89f81 100644 --- a/cloudstack/VMGroupService.go +++ b/cloudstack/VMGroupService.go @@ -178,6 +178,7 @@ type CreateInstanceGroupResponse struct { Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` JobID string `json:"jobid"` @@ -653,6 +654,7 @@ type InstanceGroup struct { Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` JobID string `json:"jobid"` @@ -751,6 +753,7 @@ type UpdateInstanceGroupResponse struct { Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` JobID string `json:"jobid"` diff --git a/cloudstack/VPCService.go b/cloudstack/VPCService.go index 857c44c1..7af00933 100644 --- a/cloudstack/VPCService.go +++ b/cloudstack/VPCService.go @@ -33,9 +33,9 @@ type VPCServiceIface interface { CreateStaticRoute(p *CreateStaticRouteParams) (*CreateStaticRouteResponse, error) NewCreateStaticRouteParams(cidr string, gatewayid string) *CreateStaticRouteParams CreateVPC(p *CreateVPCParams) (*CreateVPCResponse, error) - NewCreateVPCParams(cidr string, displaytext string, name string, vpcofferingid string, zoneid string) *CreateVPCParams + NewCreateVPCParams(displaytext string, name string, vpcofferingid string, zoneid string) *CreateVPCParams CreateVPCOffering(p *CreateVPCOfferingParams) (*CreateVPCOfferingResponse, error) - NewCreateVPCOfferingParams(displaytext string, name string, supportedservices []string) *CreateVPCOfferingParams + NewCreateVPCOfferingParams(displaytext string, name string) *CreateVPCOfferingParams DeletePrivateGateway(p *DeletePrivateGatewayParams) (*DeletePrivateGatewayResponse, error) NewDeletePrivateGatewayParams(id string) *DeletePrivateGatewayParams DeleteStaticRoute(p *DeleteStaticRouteParams) (*DeleteStaticRouteResponse, error) @@ -401,6 +401,7 @@ type CreatePrivateGatewayResponse struct { Associatednetworkid string `json:"associatednetworkid"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gateway string `json:"gateway"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -526,19 +527,20 @@ func (s *VPCService) CreateStaticRoute(p *CreateStaticRouteParams) (*CreateStati } type CreateStaticRouteResponse struct { - Account string `json:"account"` - Cidr string `json:"cidr"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Gatewayid string `json:"gatewayid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Project string `json:"project"` - Projectid string `json:"projectid"` - State string `json:"state"` - Tags []Tags `json:"tags"` - Vpcid string `json:"vpcid"` + Account string `json:"account"` + Cidr string `json:"cidr"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Gatewayid string `json:"gatewayid"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Project string `json:"project"` + Projectid string `json:"projectid"` + State string `json:"state"` + Tags []Tags `json:"tags"` + Vpcid string `json:"vpcid"` } type CreateVPCParams struct { @@ -553,9 +555,21 @@ func (p *CreateVPCParams) toURLValues() url.Values { if v, found := p.p["account"]; found { u.Set("account", v.(string)) } + if v, found := p.p["asnumber"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("asnumber", vv) + } + if v, found := p.p["bgppeerids"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("bgppeerids", vv) + } if v, found := p.p["cidr"]; found { u.Set("cidr", v.(string)) } + if v, found := p.p["cidrsize"]; found { + vv := strconv.Itoa(v.(int)) + u.Set("cidrsize", vv) + } if v, found := p.p["displaytext"]; found { u.Set("displaytext", v.(string)) } @@ -628,6 +642,48 @@ func (p *CreateVPCParams) GetAccount() (string, bool) { return value, ok } +func (p *CreateVPCParams) SetAsnumber(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["asnumber"] = v +} + +func (p *CreateVPCParams) ResetAsnumber() { + if p.p != nil && p.p["asnumber"] != nil { + delete(p.p, "asnumber") + } +} + +func (p *CreateVPCParams) GetAsnumber() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["asnumber"].(int64) + return value, ok +} + +func (p *CreateVPCParams) SetBgppeerids(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["bgppeerids"] = v +} + +func (p *CreateVPCParams) ResetBgppeerids() { + if p.p != nil && p.p["bgppeerids"] != nil { + delete(p.p, "bgppeerids") + } +} + +func (p *CreateVPCParams) GetBgppeerids() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["bgppeerids"].([]string) + return value, ok +} + func (p *CreateVPCParams) SetCidr(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -649,6 +705,27 @@ func (p *CreateVPCParams) GetCidr() (string, bool) { return value, ok } +func (p *CreateVPCParams) SetCidrsize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cidrsize"] = v +} + +func (p *CreateVPCParams) ResetCidrsize() { + if p.p != nil && p.p["cidrsize"] != nil { + delete(p.p, "cidrsize") + } +} + +func (p *CreateVPCParams) GetCidrsize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cidrsize"].(int) + return value, ok +} + func (p *CreateVPCParams) SetDisplaytext(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -966,10 +1043,9 @@ func (p *CreateVPCParams) GetZoneid() (string, bool) { // You should always use this function to get a new CreateVPCParams instance, // as then you are sure you have configured all required params -func (s *VPCService) NewCreateVPCParams(cidr string, displaytext string, name string, vpcofferingid string, zoneid string) *CreateVPCParams { +func (s *VPCService) NewCreateVPCParams(displaytext string, name string, vpcofferingid string, zoneid string) *CreateVPCParams { p := &CreateVPCParams{} p.p = make(map[string]interface{}) - p.p["cidr"] = cidr p.p["displaytext"] = displaytext p.p["name"] = name p.p["vpcofferingid"] = vpcofferingid @@ -1014,6 +1090,9 @@ func (s *VPCService) CreateVPC(p *CreateVPCParams) (*CreateVPCResponse, error) { type CreateVPCResponse struct { Account string `json:"account"` + Asnumber int64 `json:"asnumber"` + Asnumberid string `json:"asnumberid"` + Bgppeers []interface{} `json:"bgppeers"` Cidr string `json:"cidr"` Created string `json:"created"` Displaytext string `json:"displaytext"` @@ -1022,10 +1101,13 @@ type CreateVPCResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Ip4routes []interface{} `json:"ip4routes"` + Ip4routing string `json:"ip4routing"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` Ip6routes []interface{} `json:"ip6routes"` @@ -1091,12 +1173,26 @@ func (p *CreateVPCOfferingParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("enable", vv) } + if v, found := p.p["fornsx"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("fornsx", vv) + } if v, found := p.p["internetprotocol"]; found { u.Set("internetprotocol", v.(string)) } if v, found := p.p["name"]; found { u.Set("name", v.(string)) } + if v, found := p.p["networkmode"]; found { + u.Set("networkmode", v.(string)) + } + if v, found := p.p["nsxsupportlb"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("nsxsupportlb", vv) + } + if v, found := p.p["routingmode"]; found { + u.Set("routingmode", v.(string)) + } if v, found := p.p["servicecapabilitylist"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -1114,6 +1210,10 @@ func (p *CreateVPCOfferingParams) toURLValues() url.Values { u.Set(fmt.Sprintf("serviceproviderlist[%d].provider", i), m[k]) } } + if v, found := p.p["specifyasnumber"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("specifyasnumber", vv) + } if v, found := p.p["supportedservices"]; found { vv := strings.Join(v.([]string), ",") u.Set("supportedservices", vv) @@ -1188,6 +1288,27 @@ func (p *CreateVPCOfferingParams) GetEnable() (bool, bool) { return value, ok } +func (p *CreateVPCOfferingParams) SetFornsx(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["fornsx"] = v +} + +func (p *CreateVPCOfferingParams) ResetFornsx() { + if p.p != nil && p.p["fornsx"] != nil { + delete(p.p, "fornsx") + } +} + +func (p *CreateVPCOfferingParams) GetFornsx() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["fornsx"].(bool) + return value, ok +} + func (p *CreateVPCOfferingParams) SetInternetprotocol(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1230,6 +1351,69 @@ func (p *CreateVPCOfferingParams) GetName() (string, bool) { return value, ok } +func (p *CreateVPCOfferingParams) SetNetworkmode(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["networkmode"] = v +} + +func (p *CreateVPCOfferingParams) ResetNetworkmode() { + if p.p != nil && p.p["networkmode"] != nil { + delete(p.p, "networkmode") + } +} + +func (p *CreateVPCOfferingParams) GetNetworkmode() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["networkmode"].(string) + return value, ok +} + +func (p *CreateVPCOfferingParams) SetNsxsupportlb(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["nsxsupportlb"] = v +} + +func (p *CreateVPCOfferingParams) ResetNsxsupportlb() { + if p.p != nil && p.p["nsxsupportlb"] != nil { + delete(p.p, "nsxsupportlb") + } +} + +func (p *CreateVPCOfferingParams) GetNsxsupportlb() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["nsxsupportlb"].(bool) + return value, ok +} + +func (p *CreateVPCOfferingParams) SetRoutingmode(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["routingmode"] = v +} + +func (p *CreateVPCOfferingParams) ResetRoutingmode() { + if p.p != nil && p.p["routingmode"] != nil { + delete(p.p, "routingmode") + } +} + +func (p *CreateVPCOfferingParams) GetRoutingmode() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["routingmode"].(string) + return value, ok +} + func (p *CreateVPCOfferingParams) SetServicecapabilitylist(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1293,6 +1477,27 @@ func (p *CreateVPCOfferingParams) GetServiceproviderlist() (map[string]string, b return value, ok } +func (p *CreateVPCOfferingParams) SetSpecifyasnumber(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["specifyasnumber"] = v +} + +func (p *CreateVPCOfferingParams) ResetSpecifyasnumber() { + if p.p != nil && p.p["specifyasnumber"] != nil { + delete(p.p, "specifyasnumber") + } +} + +func (p *CreateVPCOfferingParams) GetSpecifyasnumber() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["specifyasnumber"].(bool) + return value, ok +} + func (p *CreateVPCOfferingParams) SetSupportedservices(v []string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1337,12 +1542,11 @@ func (p *CreateVPCOfferingParams) GetZoneid() ([]string, bool) { // You should always use this function to get a new CreateVPCOfferingParams instance, // as then you are sure you have configured all required params -func (s *VPCService) NewCreateVPCOfferingParams(displaytext string, name string, supportedservices []string) *CreateVPCOfferingParams { +func (s *VPCService) NewCreateVPCOfferingParams(displaytext string, name string) *CreateVPCOfferingParams { p := &CreateVPCOfferingParams{} p.p = make(map[string]interface{}) p.p["displaytext"] = displaytext p.p["name"] = name - p.p["supportedservices"] = supportedservices return p } @@ -1387,13 +1591,17 @@ type CreateVPCOfferingResponse struct { Distributedvpcrouter bool `json:"distributedvpcrouter"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Fornsx bool `json:"fornsx"` Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` + Networkmode string `json:"networkmode"` + Routingmode string `json:"routingmode"` Service []CreateVPCOfferingResponseService `json:"service"` + Specifyasnumber bool `json:"specifyasnumber"` State string `json:"state"` SupportsregionLevelvpc bool `json:"supportsregionLevelvpc"` Zone string `json:"zone"` @@ -2147,6 +2355,7 @@ type PrivateGateway struct { Associatednetworkid string `json:"associatednetworkid"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Gateway string `json:"gateway"` Hasannotations bool `json:"hasannotations"` Id string `json:"id"` @@ -2560,19 +2769,20 @@ type ListStaticRoutesResponse struct { } type StaticRoute struct { - Account string `json:"account"` - Cidr string `json:"cidr"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Gatewayid string `json:"gatewayid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Project string `json:"project"` - Projectid string `json:"projectid"` - State string `json:"state"` - Tags []Tags `json:"tags"` - Vpcid string `json:"vpcid"` + Account string `json:"account"` + Cidr string `json:"cidr"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Gatewayid string `json:"gatewayid"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Project string `json:"project"` + Projectid string `json:"projectid"` + State string `json:"state"` + Tags []Tags `json:"tags"` + Vpcid string `json:"vpcid"` } type ListVPCOfferingsParams struct { @@ -2972,13 +3182,17 @@ type VPCOffering struct { Distributedvpcrouter bool `json:"distributedvpcrouter"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Fornsx bool `json:"fornsx"` Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` + Networkmode string `json:"networkmode"` + Routingmode string `json:"routingmode"` Service []VPCOfferingService `json:"service"` + Specifyasnumber bool `json:"specifyasnumber"` State string `json:"state"` SupportsregionLevelvpc bool `json:"supportsregionLevelvpc"` Zone string `json:"zone"` @@ -3624,6 +3838,9 @@ type ListVPCsResponse struct { type VPC struct { Account string `json:"account"` + Asnumber int64 `json:"asnumber"` + Asnumberid string `json:"asnumberid"` + Bgppeers []interface{} `json:"bgppeers"` Cidr string `json:"cidr"` Created string `json:"created"` Displaytext string `json:"displaytext"` @@ -3632,10 +3849,13 @@ type VPC struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Ip4routes []interface{} `json:"ip4routes"` + Ip4routing string `json:"ip4routing"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` Ip6routes []interface{} `json:"ip6routes"` @@ -4066,6 +4286,9 @@ func (s *VPCService) UpdateVPC(p *UpdateVPCParams) (*UpdateVPCResponse, error) { type UpdateVPCResponse struct { Account string `json:"account"` + Asnumber int64 `json:"asnumber"` + Asnumberid string `json:"asnumberid"` + Bgppeers []interface{} `json:"bgppeers"` Cidr string `json:"cidr"` Created string `json:"created"` Displaytext string `json:"displaytext"` @@ -4074,10 +4297,13 @@ type UpdateVPCResponse struct { Dns2 string `json:"dns2"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Hasannotations bool `json:"hasannotations"` Icon interface{} `json:"icon"` Id string `json:"id"` + Ip4routes []interface{} `json:"ip4routes"` + Ip4routing string `json:"ip4routing"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` Ip6routes []interface{} `json:"ip6routes"` @@ -4354,13 +4580,17 @@ type UpdateVPCOfferingResponse struct { Distributedvpcrouter bool `json:"distributedvpcrouter"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Fornsx bool `json:"fornsx"` Id string `json:"id"` Internetprotocol string `json:"internetprotocol"` Isdefault bool `json:"isdefault"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` + Networkmode string `json:"networkmode"` + Routingmode string `json:"routingmode"` Service []UpdateVPCOfferingResponseService `json:"service"` + Specifyasnumber bool `json:"specifyasnumber"` State string `json:"state"` SupportsregionLevelvpc bool `json:"supportsregionLevelvpc"` Zone string `json:"zone"` diff --git a/cloudstack/VPCService_mock.go b/cloudstack/VPCService_mock.go index 33dde553..567d26d1 100644 --- a/cloudstack/VPCService_mock.go +++ b/cloudstack/VPCService_mock.go @@ -429,31 +429,31 @@ func (mr *MockVPCServiceIfaceMockRecorder) NewCreateStaticRouteParams(cidr, gate } // NewCreateVPCOfferingParams mocks base method. -func (m *MockVPCServiceIface) NewCreateVPCOfferingParams(displaytext, name string, supportedservices []string) *CreateVPCOfferingParams { +func (m *MockVPCServiceIface) NewCreateVPCOfferingParams(displaytext, name string) *CreateVPCOfferingParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewCreateVPCOfferingParams", displaytext, name, supportedservices) + ret := m.ctrl.Call(m, "NewCreateVPCOfferingParams", displaytext, name) ret0, _ := ret[0].(*CreateVPCOfferingParams) return ret0 } // NewCreateVPCOfferingParams indicates an expected call of NewCreateVPCOfferingParams. -func (mr *MockVPCServiceIfaceMockRecorder) NewCreateVPCOfferingParams(displaytext, name, supportedservices interface{}) *gomock.Call { +func (mr *MockVPCServiceIfaceMockRecorder) NewCreateVPCOfferingParams(displaytext, name interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateVPCOfferingParams", reflect.TypeOf((*MockVPCServiceIface)(nil).NewCreateVPCOfferingParams), displaytext, name, supportedservices) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateVPCOfferingParams", reflect.TypeOf((*MockVPCServiceIface)(nil).NewCreateVPCOfferingParams), displaytext, name) } // NewCreateVPCParams mocks base method. -func (m *MockVPCServiceIface) NewCreateVPCParams(cidr, displaytext, name, vpcofferingid, zoneid string) *CreateVPCParams { +func (m *MockVPCServiceIface) NewCreateVPCParams(displaytext, name, vpcofferingid, zoneid string) *CreateVPCParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewCreateVPCParams", cidr, displaytext, name, vpcofferingid, zoneid) + ret := m.ctrl.Call(m, "NewCreateVPCParams", displaytext, name, vpcofferingid, zoneid) ret0, _ := ret[0].(*CreateVPCParams) return ret0 } // NewCreateVPCParams indicates an expected call of NewCreateVPCParams. -func (mr *MockVPCServiceIfaceMockRecorder) NewCreateVPCParams(cidr, displaytext, name, vpcofferingid, zoneid interface{}) *gomock.Call { +func (mr *MockVPCServiceIfaceMockRecorder) NewCreateVPCParams(displaytext, name, vpcofferingid, zoneid interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateVPCParams", reflect.TypeOf((*MockVPCServiceIface)(nil).NewCreateVPCParams), cidr, displaytext, name, vpcofferingid, zoneid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewCreateVPCParams", reflect.TypeOf((*MockVPCServiceIface)(nil).NewCreateVPCParams), displaytext, name, vpcofferingid, zoneid) } // NewDeletePrivateGatewayParams mocks base method. diff --git a/cloudstack/VPNService.go b/cloudstack/VPNService.go index 0ec325c9..fbbebc2b 100644 --- a/cloudstack/VPNService.go +++ b/cloudstack/VPNService.go @@ -255,16 +255,17 @@ func (s *VPNService) AddVpnUser(p *AddVpnUserParams) (*AddVpnUserResponse, error } type AddVpnUserResponse struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Project string `json:"project"` - Projectid string `json:"projectid"` - State string `json:"state"` - Username string `json:"username"` + Account string `json:"account"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Project string `json:"project"` + Projectid string `json:"projectid"` + State string `json:"state"` + Username string `json:"username"` } type CreateRemoteAccessVpnParams struct { @@ -473,6 +474,7 @@ type CreateRemoteAccessVpnResponse struct { Account string `json:"account"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` Iprange string `json:"iprange"` @@ -647,6 +649,7 @@ type CreateVpnConnectionResponse struct { Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Dpd bool `json:"dpd"` Esplifetime int64 `json:"esplifetime"` Esppolicy string `json:"esppolicy"` @@ -1101,6 +1104,7 @@ type CreateVpnCustomerGatewayResponse struct { Cidrlist string `json:"cidrlist"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Dpd bool `json:"dpd"` Esplifetime int64 `json:"esplifetime"` Esppolicy string `json:"esppolicy"` @@ -1231,6 +1235,7 @@ type CreateVpnGatewayResponse struct { Account string `json:"account"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` JobID string `json:"jobid"` @@ -1941,6 +1946,7 @@ type RemoteAccessVpn struct { Account string `json:"account"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` Iprange string `json:"iprange"` @@ -2302,6 +2308,7 @@ type VpnConnection struct { Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Dpd bool `json:"dpd"` Esplifetime int64 `json:"esplifetime"` Esppolicy string `json:"esppolicy"` @@ -2674,6 +2681,7 @@ type VpnCustomerGateway struct { Cidrlist string `json:"cidrlist"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Dpd bool `json:"dpd"` Esplifetime int64 `json:"esplifetime"` Esppolicy string `json:"esppolicy"` @@ -3041,6 +3049,7 @@ type VpnGateway struct { Account string `json:"account"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` JobID string `json:"jobid"` @@ -3371,16 +3380,17 @@ type ListVpnUsersResponse struct { } type VpnUser struct { - Account string `json:"account"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Project string `json:"project"` - Projectid string `json:"projectid"` - State string `json:"state"` - Username string `json:"username"` + Account string `json:"account"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Project string `json:"project"` + Projectid string `json:"projectid"` + State string `json:"state"` + Username string `json:"username"` } type RemoveVpnUserParams struct { @@ -3671,6 +3681,7 @@ type ResetVpnConnectionResponse struct { Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Dpd bool `json:"dpd"` Esplifetime int64 `json:"esplifetime"` Esppolicy string `json:"esppolicy"` @@ -3828,6 +3839,7 @@ type UpdateRemoteAccessVpnResponse struct { Account string `json:"account"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` Iprange string `json:"iprange"` @@ -3976,6 +3988,7 @@ type UpdateVpnConnectionResponse struct { Created string `json:"created"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Dpd bool `json:"dpd"` Esplifetime int64 `json:"esplifetime"` Esppolicy string `json:"esppolicy"` @@ -4431,6 +4444,7 @@ type UpdateVpnCustomerGatewayResponse struct { Cidrlist string `json:"cidrlist"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Dpd bool `json:"dpd"` Esplifetime int64 `json:"esplifetime"` Esppolicy string `json:"esppolicy"` @@ -4585,6 +4599,7 @@ type UpdateVpnGatewayResponse struct { Account string `json:"account"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Fordisplay bool `json:"fordisplay"` Id string `json:"id"` JobID string `json:"jobid"` diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 9da4b050..9a1aae71 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -279,6 +279,7 @@ type AddNicToVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -290,6 +291,7 @@ type AddNicToVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -303,6 +305,7 @@ type AddNicToVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -340,6 +343,7 @@ type AddNicToVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -351,6 +355,7 @@ type AddNicToVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -362,6 +367,7 @@ type AddNicToVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []AddNicToVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []AddNicToVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -387,16 +393,18 @@ type AddNicToVirtualMachineResponseSecuritygroupRule struct { } type AddNicToVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *AddNicToVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -621,6 +629,7 @@ type AssignVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -632,6 +641,7 @@ type AssignVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -645,6 +655,7 @@ type AssignVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -682,6 +693,7 @@ type AssignVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -693,6 +705,7 @@ type AssignVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -704,6 +717,7 @@ type AssignVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []AssignVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []AssignVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -729,16 +743,18 @@ type AssignVirtualMachineResponseSecuritygroupRule struct { } type AssignVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *AssignVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -993,6 +1009,7 @@ type ChangeServiceForVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -1004,6 +1021,7 @@ type ChangeServiceForVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -1017,6 +1035,7 @@ type ChangeServiceForVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -1054,6 +1073,7 @@ type ChangeServiceForVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -1065,6 +1085,7 @@ type ChangeServiceForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -1076,6 +1097,7 @@ type ChangeServiceForVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []ChangeServiceForVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []ChangeServiceForVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -1101,16 +1123,18 @@ type ChangeServiceForVirtualMachineResponseSecuritygroupRule struct { } type ChangeServiceForVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *ChangeServiceForVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -2604,6 +2628,7 @@ type DeployVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -2615,6 +2640,7 @@ type DeployVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -2628,6 +2654,7 @@ type DeployVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -2665,6 +2692,7 @@ type DeployVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -2676,6 +2704,7 @@ type DeployVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -2687,6 +2716,7 @@ type DeployVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []DeployVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []DeployVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -2712,16 +2742,18 @@ type DeployVirtualMachineResponseSecuritygroupRule struct { } type DeployVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *DeployVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -2894,6 +2926,7 @@ type DestroyVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -2905,6 +2938,7 @@ type DestroyVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -2918,6 +2952,7 @@ type DestroyVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -2955,6 +2990,7 @@ type DestroyVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -2966,6 +3002,7 @@ type DestroyVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -2977,6 +3014,7 @@ type DestroyVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []DestroyVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []DestroyVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -3002,16 +3040,18 @@ type DestroyVirtualMachineResponseSecuritygroupRule struct { } type DestroyVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *DestroyVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -4303,6 +4343,7 @@ type VirtualMachine struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -4314,6 +4355,7 @@ type VirtualMachine struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -4327,6 +4369,7 @@ type VirtualMachine struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -4364,6 +4407,7 @@ type VirtualMachine struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -4375,6 +4419,7 @@ type VirtualMachine struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -4386,6 +4431,7 @@ type VirtualMachineSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []VirtualMachineSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []VirtualMachineSecuritygroupRule `json:"ingressrule"` @@ -4411,16 +4457,18 @@ type VirtualMachineSecuritygroupRule struct { } type VirtualMachineAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *VirtualMachine) UnmarshalJSON(b []byte) error { @@ -5565,6 +5613,7 @@ type VirtualMachinesMetric struct { Cputotal string `json:"cputotal"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskiopstotal int64 `json:"diskiopstotal"` Diskioread int64 `json:"diskioread"` @@ -5579,6 +5628,7 @@ type VirtualMachinesMetric struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -5633,6 +5683,7 @@ type VirtualMachinesMetric struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -5644,6 +5695,7 @@ type VirtualMachinesMetric struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -5655,6 +5707,7 @@ type VirtualMachinesMetricSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []VirtualMachinesMetricSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []VirtualMachinesMetricSecuritygroupRule `json:"ingressrule"` @@ -5680,16 +5733,18 @@ type VirtualMachinesMetricSecuritygroupRule struct { } type VirtualMachinesMetricAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *VirtualMachinesMetric) UnmarshalJSON(b []byte) error { @@ -5885,6 +5940,7 @@ type MigrateVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -5896,6 +5952,7 @@ type MigrateVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -5909,6 +5966,7 @@ type MigrateVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -5946,6 +6004,7 @@ type MigrateVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -5957,6 +6016,7 @@ type MigrateVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -5968,6 +6028,7 @@ type MigrateVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []MigrateVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []MigrateVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -5993,16 +6054,18 @@ type MigrateVirtualMachineResponseSecuritygroupRule struct { } type MigrateVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *MigrateVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -6217,6 +6280,7 @@ type MigrateVirtualMachineWithVolumeResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -6228,6 +6292,7 @@ type MigrateVirtualMachineWithVolumeResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -6241,6 +6306,7 @@ type MigrateVirtualMachineWithVolumeResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -6278,6 +6344,7 @@ type MigrateVirtualMachineWithVolumeResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -6289,6 +6356,7 @@ type MigrateVirtualMachineWithVolumeResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -6300,6 +6368,7 @@ type MigrateVirtualMachineWithVolumeResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []MigrateVirtualMachineWithVolumeResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []MigrateVirtualMachineWithVolumeResponseSecuritygroupRule `json:"ingressrule"` @@ -6325,16 +6394,18 @@ type MigrateVirtualMachineWithVolumeResponseSecuritygroupRule struct { } type MigrateVirtualMachineWithVolumeResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *MigrateVirtualMachineWithVolumeResponse) UnmarshalJSON(b []byte) error { @@ -6507,6 +6578,7 @@ type RebootVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -6518,6 +6590,7 @@ type RebootVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -6531,6 +6604,7 @@ type RebootVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -6568,6 +6642,7 @@ type RebootVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -6579,6 +6654,7 @@ type RebootVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -6590,6 +6666,7 @@ type RebootVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []RebootVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []RebootVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -6615,16 +6692,18 @@ type RebootVirtualMachineResponseSecuritygroupRule struct { } type RebootVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *RebootVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -6727,6 +6806,7 @@ type RecoverVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -6738,6 +6818,7 @@ type RecoverVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -6751,6 +6832,7 @@ type RecoverVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -6788,6 +6870,7 @@ type RecoverVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -6799,6 +6882,7 @@ type RecoverVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -6810,6 +6894,7 @@ type RecoverVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []RecoverVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []RecoverVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -6835,16 +6920,18 @@ type RecoverVirtualMachineResponseSecuritygroupRule struct { } type RecoverVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *RecoverVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -6992,6 +7079,7 @@ type RemoveNicFromVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -7003,6 +7091,7 @@ type RemoveNicFromVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -7016,6 +7105,7 @@ type RemoveNicFromVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -7053,6 +7143,7 @@ type RemoveNicFromVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -7064,6 +7155,7 @@ type RemoveNicFromVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -7075,6 +7167,7 @@ type RemoveNicFromVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []RemoveNicFromVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []RemoveNicFromVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -7100,16 +7193,18 @@ type RemoveNicFromVirtualMachineResponseSecuritygroupRule struct { } type RemoveNicFromVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *RemoveNicFromVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -7256,6 +7351,7 @@ type ResetPasswordForVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -7267,6 +7363,7 @@ type ResetPasswordForVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -7280,6 +7377,7 @@ type ResetPasswordForVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -7317,6 +7415,7 @@ type ResetPasswordForVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -7328,6 +7427,7 @@ type ResetPasswordForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -7339,6 +7439,7 @@ type ResetPasswordForVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []ResetPasswordForVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []ResetPasswordForVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -7364,16 +7465,18 @@ type ResetPasswordForVirtualMachineResponseSecuritygroupRule struct { } type ResetPasswordForVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *ResetPasswordForVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -7412,6 +7515,23 @@ func (p *RestoreVirtualMachineParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["details"]; found { + m := v.(map[string]string) + for i, k := range getSortedKeysFromMap(m) { + u.Set(fmt.Sprintf("details[%d].%s", i, k), m[k]) + } + } + if v, found := p.p["diskofferingid"]; found { + u.Set("diskofferingid", v.(string)) + } + if v, found := p.p["expunge"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("expunge", vv) + } + if v, found := p.p["rootdisksize"]; found { + vv := strconv.FormatInt(v.(int64), 10) + u.Set("rootdisksize", vv) + } if v, found := p.p["templateid"]; found { u.Set("templateid", v.(string)) } @@ -7421,6 +7541,90 @@ func (p *RestoreVirtualMachineParams) toURLValues() url.Values { return u } +func (p *RestoreVirtualMachineParams) SetDetails(v map[string]string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["details"] = v +} + +func (p *RestoreVirtualMachineParams) ResetDetails() { + if p.p != nil && p.p["details"] != nil { + delete(p.p, "details") + } +} + +func (p *RestoreVirtualMachineParams) GetDetails() (map[string]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["details"].(map[string]string) + return value, ok +} + +func (p *RestoreVirtualMachineParams) SetDiskofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["diskofferingid"] = v +} + +func (p *RestoreVirtualMachineParams) ResetDiskofferingid() { + if p.p != nil && p.p["diskofferingid"] != nil { + delete(p.p, "diskofferingid") + } +} + +func (p *RestoreVirtualMachineParams) GetDiskofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["diskofferingid"].(string) + return value, ok +} + +func (p *RestoreVirtualMachineParams) SetExpunge(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["expunge"] = v +} + +func (p *RestoreVirtualMachineParams) ResetExpunge() { + if p.p != nil && p.p["expunge"] != nil { + delete(p.p, "expunge") + } +} + +func (p *RestoreVirtualMachineParams) GetExpunge() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["expunge"].(bool) + return value, ok +} + +func (p *RestoreVirtualMachineParams) SetRootdisksize(v int64) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["rootdisksize"] = v +} + +func (p *RestoreVirtualMachineParams) ResetRootdisksize() { + if p.p != nil && p.p["rootdisksize"] != nil { + delete(p.p, "rootdisksize") + } +} + +func (p *RestoreVirtualMachineParams) GetRootdisksize() (int64, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["rootdisksize"].(int64) + return value, ok +} + func (p *RestoreVirtualMachineParams) SetTemplateid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -7520,6 +7724,7 @@ type RestoreVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -7531,6 +7736,7 @@ type RestoreVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -7544,6 +7750,7 @@ type RestoreVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -7581,6 +7788,7 @@ type RestoreVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -7592,6 +7800,7 @@ type RestoreVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -7603,6 +7812,7 @@ type RestoreVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []RestoreVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []RestoreVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -7628,16 +7838,18 @@ type RestoreVirtualMachineResponseSecuritygroupRule struct { } type RestoreVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *RestoreVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -8140,6 +8352,7 @@ type StartVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -8151,6 +8364,7 @@ type StartVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -8164,6 +8378,7 @@ type StartVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -8201,6 +8416,7 @@ type StartVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -8212,6 +8428,7 @@ type StartVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -8223,6 +8440,7 @@ type StartVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []StartVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []StartVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -8248,16 +8466,18 @@ type StartVirtualMachineResponseSecuritygroupRule struct { } type StartVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *StartVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -8405,6 +8625,7 @@ type StopVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -8416,6 +8637,7 @@ type StopVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -8429,6 +8651,7 @@ type StopVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -8466,6 +8689,7 @@ type StopVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -8477,6 +8701,7 @@ type StopVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -8488,6 +8713,7 @@ type StopVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []StopVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []StopVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -8513,16 +8739,18 @@ type StopVirtualMachineResponseSecuritygroupRule struct { } type StopVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *StopVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -8670,6 +8898,7 @@ type UpdateDefaultNicForVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -8681,6 +8910,7 @@ type UpdateDefaultNicForVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -8694,6 +8924,7 @@ type UpdateDefaultNicForVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -8731,6 +8962,7 @@ type UpdateDefaultNicForVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -8742,6 +8974,7 @@ type UpdateDefaultNicForVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -8753,6 +8986,7 @@ type UpdateDefaultNicForVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []UpdateDefaultNicForVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []UpdateDefaultNicForVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -8778,16 +9012,18 @@ type UpdateDefaultNicForVirtualMachineResponseSecuritygroupRule struct { } type UpdateDefaultNicForVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *UpdateDefaultNicForVirtualMachineResponse) UnmarshalJSON(b []byte) error { @@ -8833,6 +9069,10 @@ func (p *UpdateVirtualMachineParams) toURLValues() url.Values { if v, found := p.p["customid"]; found { u.Set("customid", v.(string)) } + if v, found := p.p["deleteprotection"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("deleteprotection", vv) + } if v, found := p.p["details"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -8946,6 +9186,27 @@ func (p *UpdateVirtualMachineParams) GetCustomid() (string, bool) { return value, ok } +func (p *UpdateVirtualMachineParams) SetDeleteprotection(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["deleteprotection"] = v +} + +func (p *UpdateVirtualMachineParams) ResetDeleteprotection() { + if p.p != nil && p.p["deleteprotection"] != nil { + delete(p.p, "deleteprotection") + } +} + +func (p *UpdateVirtualMachineParams) GetDeleteprotection() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["deleteprotection"].(bool) + return value, ok +} + func (p *UpdateVirtualMachineParams) SetDetails(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -9354,6 +9615,7 @@ type UpdateVirtualMachineResponse struct { Cpuspeed int `json:"cpuspeed"` Cpuused string `json:"cpuused"` Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` Details map[string]string `json:"details"` Diskioread int64 `json:"diskioread"` Diskiowrite int64 `json:"diskiowrite"` @@ -9365,6 +9627,7 @@ type UpdateVirtualMachineResponse struct { Displayvm bool `json:"displayvm"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Forvirtualnetwork bool `json:"forvirtualnetwork"` Group string `json:"group"` Groupid string `json:"groupid"` @@ -9378,6 +9641,7 @@ type UpdateVirtualMachineResponse struct { Icon interface{} `json:"icon"` Id string `json:"id"` Instancename string `json:"instancename"` + Ipaddress string `json:"ipaddress"` Isdynamicallyscalable bool `json:"isdynamicallyscalable"` Isodisplaytext string `json:"isodisplaytext"` Isoid string `json:"isoid"` @@ -9415,6 +9679,7 @@ type UpdateVirtualMachineResponse struct { State string `json:"state"` Tags []Tags `json:"tags"` Templatedisplaytext string `json:"templatedisplaytext"` + Templateformat string `json:"templateformat"` Templateid string `json:"templateid"` Templatename string `json:"templatename"` Templatetype string `json:"templatetype"` @@ -9426,6 +9691,7 @@ type UpdateVirtualMachineResponse struct { Userid string `json:"userid"` Username string `json:"username"` Vgpu string `json:"vgpu"` + Vmtype string `json:"vmtype"` Vnfdetails map[string]string `json:"vnfdetails"` Vnfnics []string `json:"vnfnics"` Zoneid string `json:"zoneid"` @@ -9437,6 +9703,7 @@ type UpdateVirtualMachineResponseSecuritygroup struct { Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` Egressrule []UpdateVirtualMachineResponseSecuritygroupRule `json:"egressrule"` Id string `json:"id"` Ingressrule []UpdateVirtualMachineResponseSecuritygroupRule `json:"ingressrule"` @@ -9462,16 +9729,18 @@ type UpdateVirtualMachineResponseSecuritygroupRule struct { } type UpdateVirtualMachineResponseAffinitygroup struct { - Account string `json:"account"` - Description string `json:"description"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Id string `json:"id"` - Name string `json:"name"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Type string `json:"type"` - VirtualmachineIds []string `json:"virtualmachineIds"` + Account string `json:"account"` + Dedicatedresources []string `json:"dedicatedresources"` + Description string `json:"description"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Id string `json:"id"` + Name string `json:"name"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Type string `json:"type"` + VirtualmachineIds []string `json:"virtualmachineIds"` } func (r *UpdateVirtualMachineResponse) UnmarshalJSON(b []byte) error { diff --git a/cloudstack/VolumeService.go b/cloudstack/VolumeService.go index 65ce8263..281e52de 100644 --- a/cloudstack/VolumeService.go +++ b/cloudstack/VolumeService.go @@ -203,74 +203,79 @@ func (s *VolumeService) AttachVolume(p *AttachVolumeParams) (*AttachVolumeRespon } type AttachVolumeResponse struct { - Account string `json:"account"` - Attached string `json:"attached"` - Chaininfo string `json:"chaininfo"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Created string `json:"created"` - Destroyed bool `json:"destroyed"` - Deviceid int64 `json:"deviceid"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - Diskioread int64 `json:"diskioread"` - Diskiowrite int64 `json:"diskiowrite"` - Diskkbsread int64 `json:"diskkbsread"` - Diskkbswrite int64 `json:"diskkbswrite"` - Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` - Diskofferingid string `json:"diskofferingid"` - Diskofferingname string `json:"diskofferingname"` - Displayvolume bool `json:"displayvolume"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externaluuid string `json:"externaluuid"` - Hasannotations bool `json:"hasannotations"` - Hypervisor string `json:"hypervisor"` - Id string `json:"id"` - Isextractable bool `json:"isextractable"` - Isodisplaytext string `json:"isodisplaytext"` - Isoid string `json:"isoid"` - Isoname string `json:"isoname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Path string `json:"path"` - Physicalsize int64 `json:"physicalsize"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Provisioningtype string `json:"provisioningtype"` - Quiescevm bool `json:"quiescevm"` - Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` - Serviceofferingid string `json:"serviceofferingid"` - Serviceofferingname string `json:"serviceofferingname"` - Size int64 `json:"size"` - Snapshotid string `json:"snapshotid"` - State string `json:"state"` - Status string `json:"status"` - Storage string `json:"storage"` - Storageid string `json:"storageid"` - Storagetype string `json:"storagetype"` - Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` - Tags []Tags `json:"tags"` - Templatedisplaytext string `json:"templatedisplaytext"` - Templateid string `json:"templateid"` - Templatename string `json:"templatename"` - Type string `json:"type"` - Utilization string `json:"utilization"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualsize int64 `json:"virtualsize"` - Vmdisplayname string `json:"vmdisplayname"` - Vmname string `json:"vmname"` - Vmstate string `json:"vmstate"` - Vmtype string `json:"vmtype"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Encryptformat string `json:"encryptformat"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` + Volumecheckresult map[string]string `json:"volumecheckresult"` + Volumerepairresult map[string]string `json:"volumerepairresult"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type CreateVolumeParams struct { @@ -645,74 +650,79 @@ func (s *VolumeService) CreateVolume(p *CreateVolumeParams) (*CreateVolumeRespon } type CreateVolumeResponse struct { - Account string `json:"account"` - Attached string `json:"attached"` - Chaininfo string `json:"chaininfo"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Created string `json:"created"` - Destroyed bool `json:"destroyed"` - Deviceid int64 `json:"deviceid"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - Diskioread int64 `json:"diskioread"` - Diskiowrite int64 `json:"diskiowrite"` - Diskkbsread int64 `json:"diskkbsread"` - Diskkbswrite int64 `json:"diskkbswrite"` - Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` - Diskofferingid string `json:"diskofferingid"` - Diskofferingname string `json:"diskofferingname"` - Displayvolume bool `json:"displayvolume"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externaluuid string `json:"externaluuid"` - Hasannotations bool `json:"hasannotations"` - Hypervisor string `json:"hypervisor"` - Id string `json:"id"` - Isextractable bool `json:"isextractable"` - Isodisplaytext string `json:"isodisplaytext"` - Isoid string `json:"isoid"` - Isoname string `json:"isoname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Path string `json:"path"` - Physicalsize int64 `json:"physicalsize"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Provisioningtype string `json:"provisioningtype"` - Quiescevm bool `json:"quiescevm"` - Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` - Serviceofferingid string `json:"serviceofferingid"` - Serviceofferingname string `json:"serviceofferingname"` - Size int64 `json:"size"` - Snapshotid string `json:"snapshotid"` - State string `json:"state"` - Status string `json:"status"` - Storage string `json:"storage"` - Storageid string `json:"storageid"` - Storagetype string `json:"storagetype"` - Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` - Tags []Tags `json:"tags"` - Templatedisplaytext string `json:"templatedisplaytext"` - Templateid string `json:"templateid"` - Templatename string `json:"templatename"` - Type string `json:"type"` - Utilization string `json:"utilization"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualsize int64 `json:"virtualsize"` - Vmdisplayname string `json:"vmdisplayname"` - Vmname string `json:"vmname"` - Vmstate string `json:"vmstate"` - Vmtype string `json:"vmtype"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Encryptformat string `json:"encryptformat"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` + Volumecheckresult map[string]string `json:"volumecheckresult"` + Volumerepairresult map[string]string `json:"volumerepairresult"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type DeleteVolumeParams struct { @@ -915,74 +925,79 @@ func (s *VolumeService) DestroyVolume(p *DestroyVolumeParams) (*DestroyVolumeRes } type DestroyVolumeResponse struct { - Account string `json:"account"` - Attached string `json:"attached"` - Chaininfo string `json:"chaininfo"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Created string `json:"created"` - Destroyed bool `json:"destroyed"` - Deviceid int64 `json:"deviceid"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - Diskioread int64 `json:"diskioread"` - Diskiowrite int64 `json:"diskiowrite"` - Diskkbsread int64 `json:"diskkbsread"` - Diskkbswrite int64 `json:"diskkbswrite"` - Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` - Diskofferingid string `json:"diskofferingid"` - Diskofferingname string `json:"diskofferingname"` - Displayvolume bool `json:"displayvolume"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externaluuid string `json:"externaluuid"` - Hasannotations bool `json:"hasannotations"` - Hypervisor string `json:"hypervisor"` - Id string `json:"id"` - Isextractable bool `json:"isextractable"` - Isodisplaytext string `json:"isodisplaytext"` - Isoid string `json:"isoid"` - Isoname string `json:"isoname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Path string `json:"path"` - Physicalsize int64 `json:"physicalsize"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Provisioningtype string `json:"provisioningtype"` - Quiescevm bool `json:"quiescevm"` - Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` - Serviceofferingid string `json:"serviceofferingid"` - Serviceofferingname string `json:"serviceofferingname"` - Size int64 `json:"size"` - Snapshotid string `json:"snapshotid"` - State string `json:"state"` - Status string `json:"status"` - Storage string `json:"storage"` - Storageid string `json:"storageid"` - Storagetype string `json:"storagetype"` - Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` - Tags []Tags `json:"tags"` - Templatedisplaytext string `json:"templatedisplaytext"` - Templateid string `json:"templateid"` - Templatename string `json:"templatename"` - Type string `json:"type"` - Utilization string `json:"utilization"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualsize int64 `json:"virtualsize"` - Vmdisplayname string `json:"vmdisplayname"` - Vmname string `json:"vmname"` - Vmstate string `json:"vmstate"` - Vmtype string `json:"vmtype"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Encryptformat string `json:"encryptformat"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` + Volumecheckresult map[string]string `json:"volumecheckresult"` + Volumerepairresult map[string]string `json:"volumerepairresult"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type DetachVolumeParams struct { @@ -1114,74 +1129,79 @@ func (s *VolumeService) DetachVolume(p *DetachVolumeParams) (*DetachVolumeRespon } type DetachVolumeResponse struct { - Account string `json:"account"` - Attached string `json:"attached"` - Chaininfo string `json:"chaininfo"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Created string `json:"created"` - Destroyed bool `json:"destroyed"` - Deviceid int64 `json:"deviceid"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - Diskioread int64 `json:"diskioread"` - Diskiowrite int64 `json:"diskiowrite"` - Diskkbsread int64 `json:"diskkbsread"` - Diskkbswrite int64 `json:"diskkbswrite"` - Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` - Diskofferingid string `json:"diskofferingid"` - Diskofferingname string `json:"diskofferingname"` - Displayvolume bool `json:"displayvolume"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externaluuid string `json:"externaluuid"` - Hasannotations bool `json:"hasannotations"` - Hypervisor string `json:"hypervisor"` - Id string `json:"id"` - Isextractable bool `json:"isextractable"` - Isodisplaytext string `json:"isodisplaytext"` - Isoid string `json:"isoid"` - Isoname string `json:"isoname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Path string `json:"path"` - Physicalsize int64 `json:"physicalsize"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Provisioningtype string `json:"provisioningtype"` - Quiescevm bool `json:"quiescevm"` - Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` - Serviceofferingid string `json:"serviceofferingid"` - Serviceofferingname string `json:"serviceofferingname"` - Size int64 `json:"size"` - Snapshotid string `json:"snapshotid"` - State string `json:"state"` - Status string `json:"status"` - Storage string `json:"storage"` - Storageid string `json:"storageid"` - Storagetype string `json:"storagetype"` - Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` - Tags []Tags `json:"tags"` - Templatedisplaytext string `json:"templatedisplaytext"` - Templateid string `json:"templateid"` - Templatename string `json:"templatename"` - Type string `json:"type"` - Utilization string `json:"utilization"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualsize int64 `json:"virtualsize"` - Vmdisplayname string `json:"vmdisplayname"` - Vmname string `json:"vmname"` - Vmstate string `json:"vmstate"` - Vmtype string `json:"vmtype"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Encryptformat string `json:"encryptformat"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` + Volumecheckresult map[string]string `json:"volumecheckresult"` + Volumerepairresult map[string]string `json:"volumerepairresult"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type ExtractVolumeParams struct { @@ -1860,6 +1880,10 @@ func (p *ListVolumesParams) toURLValues() url.Values { vv := strings.Join(v.([]string), ",") u.Set("ids", vv) } + if v, found := p.p["isencrypted"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isencrypted", vv) + } if v, found := p.p["isrecursive"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("isrecursive", vv) @@ -1896,6 +1920,9 @@ func (p *ListVolumesParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("retrieveonlyresourcecount", vv) } + if v, found := p.p["serviceofferingid"]; found { + u.Set("serviceofferingid", v.(string)) + } if v, found := p.p["state"]; found { u.Set("state", v.(string)) } @@ -2089,6 +2116,27 @@ func (p *ListVolumesParams) GetIds() ([]string, bool) { return value, ok } +func (p *ListVolumesParams) SetIsencrypted(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isencrypted"] = v +} + +func (p *ListVolumesParams) ResetIsencrypted() { + if p.p != nil && p.p["isencrypted"] != nil { + delete(p.p, "isencrypted") + } +} + +func (p *ListVolumesParams) GetIsencrypted() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isencrypted"].(bool) + return value, ok +} + func (p *ListVolumesParams) SetIsrecursive(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2299,6 +2347,27 @@ func (p *ListVolumesParams) GetRetrieveonlyresourcecount() (bool, bool) { return value, ok } +func (p *ListVolumesParams) SetServiceofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["serviceofferingid"] = v +} + +func (p *ListVolumesParams) ResetServiceofferingid() { + if p.p != nil && p.p["serviceofferingid"] != nil { + delete(p.p, "serviceofferingid") + } +} + +func (p *ListVolumesParams) GetServiceofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["serviceofferingid"].(string) + return value, ok +} + func (p *ListVolumesParams) SetState(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2537,74 +2606,79 @@ type ListVolumesResponse struct { } type Volume struct { - Account string `json:"account"` - Attached string `json:"attached"` - Chaininfo string `json:"chaininfo"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Created string `json:"created"` - Destroyed bool `json:"destroyed"` - Deviceid int64 `json:"deviceid"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - Diskioread int64 `json:"diskioread"` - Diskiowrite int64 `json:"diskiowrite"` - Diskkbsread int64 `json:"diskkbsread"` - Diskkbswrite int64 `json:"diskkbswrite"` - Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` - Diskofferingid string `json:"diskofferingid"` - Diskofferingname string `json:"diskofferingname"` - Displayvolume bool `json:"displayvolume"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externaluuid string `json:"externaluuid"` - Hasannotations bool `json:"hasannotations"` - Hypervisor string `json:"hypervisor"` - Id string `json:"id"` - Isextractable bool `json:"isextractable"` - Isodisplaytext string `json:"isodisplaytext"` - Isoid string `json:"isoid"` - Isoname string `json:"isoname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Path string `json:"path"` - Physicalsize int64 `json:"physicalsize"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Provisioningtype string `json:"provisioningtype"` - Quiescevm bool `json:"quiescevm"` - Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` - Serviceofferingid string `json:"serviceofferingid"` - Serviceofferingname string `json:"serviceofferingname"` - Size int64 `json:"size"` - Snapshotid string `json:"snapshotid"` - State string `json:"state"` - Status string `json:"status"` - Storage string `json:"storage"` - Storageid string `json:"storageid"` - Storagetype string `json:"storagetype"` - Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` - Tags []Tags `json:"tags"` - Templatedisplaytext string `json:"templatedisplaytext"` - Templateid string `json:"templateid"` - Templatename string `json:"templatename"` - Type string `json:"type"` - Utilization string `json:"utilization"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualsize int64 `json:"virtualsize"` - Vmdisplayname string `json:"vmdisplayname"` - Vmname string `json:"vmname"` - Vmstate string `json:"vmstate"` - Vmtype string `json:"vmtype"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Encryptformat string `json:"encryptformat"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` + Volumecheckresult map[string]string `json:"volumecheckresult"` + Volumerepairresult map[string]string `json:"volumerepairresult"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type ListVolumesMetricsParams struct { @@ -2642,6 +2716,10 @@ func (p *ListVolumesMetricsParams) toURLValues() url.Values { vv := strings.Join(v.([]string), ",") u.Set("ids", vv) } + if v, found := p.p["isencrypted"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("isencrypted", vv) + } if v, found := p.p["isrecursive"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("isrecursive", vv) @@ -2678,6 +2756,9 @@ func (p *ListVolumesMetricsParams) toURLValues() url.Values { vv := strconv.FormatBool(v.(bool)) u.Set("retrieveonlyresourcecount", vv) } + if v, found := p.p["serviceofferingid"]; found { + u.Set("serviceofferingid", v.(string)) + } if v, found := p.p["state"]; found { u.Set("state", v.(string)) } @@ -2871,6 +2952,27 @@ func (p *ListVolumesMetricsParams) GetIds() ([]string, bool) { return value, ok } +func (p *ListVolumesMetricsParams) SetIsencrypted(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isencrypted"] = v +} + +func (p *ListVolumesMetricsParams) ResetIsencrypted() { + if p.p != nil && p.p["isencrypted"] != nil { + delete(p.p, "isencrypted") + } +} + +func (p *ListVolumesMetricsParams) GetIsencrypted() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isencrypted"].(bool) + return value, ok +} + func (p *ListVolumesMetricsParams) SetIsrecursive(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3081,6 +3183,27 @@ func (p *ListVolumesMetricsParams) GetRetrieveonlyresourcecount() (bool, bool) { return value, ok } +func (p *ListVolumesMetricsParams) SetServiceofferingid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["serviceofferingid"] = v +} + +func (p *ListVolumesMetricsParams) ResetServiceofferingid() { + if p.p != nil && p.p["serviceofferingid"] != nil { + delete(p.p, "serviceofferingid") + } +} + +func (p *ListVolumesMetricsParams) GetServiceofferingid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["serviceofferingid"].(string) + return value, ok +} + func (p *ListVolumesMetricsParams) SetState(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3319,76 +3442,81 @@ type ListVolumesMetricsResponse struct { } type VolumesMetric struct { - Account string `json:"account"` - Attached string `json:"attached"` - Chaininfo string `json:"chaininfo"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Created string `json:"created"` - Destroyed bool `json:"destroyed"` - Deviceid int64 `json:"deviceid"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - Diskiopstotal int64 `json:"diskiopstotal"` - Diskioread int64 `json:"diskioread"` - Diskiowrite int64 `json:"diskiowrite"` - Diskkbsread int64 `json:"diskkbsread"` - Diskkbswrite int64 `json:"diskkbswrite"` - Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` - Diskofferingid string `json:"diskofferingid"` - Diskofferingname string `json:"diskofferingname"` - Displayvolume bool `json:"displayvolume"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externaluuid string `json:"externaluuid"` - Hasannotations bool `json:"hasannotations"` - Hypervisor string `json:"hypervisor"` - Id string `json:"id"` - Isextractable bool `json:"isextractable"` - Isodisplaytext string `json:"isodisplaytext"` - Isoid string `json:"isoid"` - Isoname string `json:"isoname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Path string `json:"path"` - Physicalsize int64 `json:"physicalsize"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Provisioningtype string `json:"provisioningtype"` - Quiescevm bool `json:"quiescevm"` - Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` - Serviceofferingid string `json:"serviceofferingid"` - Serviceofferingname string `json:"serviceofferingname"` - Size int64 `json:"size"` - Sizegb string `json:"sizegb"` - Snapshotid string `json:"snapshotid"` - State string `json:"state"` - Status string `json:"status"` - Storage string `json:"storage"` - Storageid string `json:"storageid"` - Storagetype string `json:"storagetype"` - Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` - Tags []Tags `json:"tags"` - Templatedisplaytext string `json:"templatedisplaytext"` - Templateid string `json:"templateid"` - Templatename string `json:"templatename"` - Type string `json:"type"` - Utilization string `json:"utilization"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualsize int64 `json:"virtualsize"` - Vmdisplayname string `json:"vmdisplayname"` - Vmname string `json:"vmname"` - Vmstate string `json:"vmstate"` - Vmtype string `json:"vmtype"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskiopstotal int64 `json:"diskiopstotal"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Encryptformat string `json:"encryptformat"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Sizegb string `json:"sizegb"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` + Volumecheckresult map[string]string `json:"volumecheckresult"` + Volumerepairresult map[string]string `json:"volumerepairresult"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type MigrateVolumeParams struct { @@ -3546,74 +3674,79 @@ func (s *VolumeService) MigrateVolume(p *MigrateVolumeParams) (*MigrateVolumeRes } type MigrateVolumeResponse struct { - Account string `json:"account"` - Attached string `json:"attached"` - Chaininfo string `json:"chaininfo"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Created string `json:"created"` - Destroyed bool `json:"destroyed"` - Deviceid int64 `json:"deviceid"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - Diskioread int64 `json:"diskioread"` - Diskiowrite int64 `json:"diskiowrite"` - Diskkbsread int64 `json:"diskkbsread"` - Diskkbswrite int64 `json:"diskkbswrite"` - Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` - Diskofferingid string `json:"diskofferingid"` - Diskofferingname string `json:"diskofferingname"` - Displayvolume bool `json:"displayvolume"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externaluuid string `json:"externaluuid"` - Hasannotations bool `json:"hasannotations"` - Hypervisor string `json:"hypervisor"` - Id string `json:"id"` - Isextractable bool `json:"isextractable"` - Isodisplaytext string `json:"isodisplaytext"` - Isoid string `json:"isoid"` - Isoname string `json:"isoname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Path string `json:"path"` - Physicalsize int64 `json:"physicalsize"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Provisioningtype string `json:"provisioningtype"` - Quiescevm bool `json:"quiescevm"` - Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` - Serviceofferingid string `json:"serviceofferingid"` - Serviceofferingname string `json:"serviceofferingname"` - Size int64 `json:"size"` - Snapshotid string `json:"snapshotid"` - State string `json:"state"` - Status string `json:"status"` - Storage string `json:"storage"` - Storageid string `json:"storageid"` - Storagetype string `json:"storagetype"` - Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` - Tags []Tags `json:"tags"` - Templatedisplaytext string `json:"templatedisplaytext"` - Templateid string `json:"templateid"` - Templatename string `json:"templatename"` - Type string `json:"type"` - Utilization string `json:"utilization"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualsize int64 `json:"virtualsize"` - Vmdisplayname string `json:"vmdisplayname"` - Vmname string `json:"vmname"` - Vmstate string `json:"vmstate"` - Vmtype string `json:"vmtype"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Encryptformat string `json:"encryptformat"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` + Volumecheckresult map[string]string `json:"volumecheckresult"` + Volumerepairresult map[string]string `json:"volumerepairresult"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type RecoverVolumeParams struct { @@ -3677,74 +3810,79 @@ func (s *VolumeService) RecoverVolume(p *RecoverVolumeParams) (*RecoverVolumeRes } type RecoverVolumeResponse struct { - Account string `json:"account"` - Attached string `json:"attached"` - Chaininfo string `json:"chaininfo"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Created string `json:"created"` - Destroyed bool `json:"destroyed"` - Deviceid int64 `json:"deviceid"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - Diskioread int64 `json:"diskioread"` - Diskiowrite int64 `json:"diskiowrite"` - Diskkbsread int64 `json:"diskkbsread"` - Diskkbswrite int64 `json:"diskkbswrite"` - Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` - Diskofferingid string `json:"diskofferingid"` - Diskofferingname string `json:"diskofferingname"` - Displayvolume bool `json:"displayvolume"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externaluuid string `json:"externaluuid"` - Hasannotations bool `json:"hasannotations"` - Hypervisor string `json:"hypervisor"` - Id string `json:"id"` - Isextractable bool `json:"isextractable"` - Isodisplaytext string `json:"isodisplaytext"` - Isoid string `json:"isoid"` - Isoname string `json:"isoname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Path string `json:"path"` - Physicalsize int64 `json:"physicalsize"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Provisioningtype string `json:"provisioningtype"` - Quiescevm bool `json:"quiescevm"` - Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` - Serviceofferingid string `json:"serviceofferingid"` - Serviceofferingname string `json:"serviceofferingname"` - Size int64 `json:"size"` - Snapshotid string `json:"snapshotid"` - State string `json:"state"` - Status string `json:"status"` - Storage string `json:"storage"` - Storageid string `json:"storageid"` - Storagetype string `json:"storagetype"` - Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` - Tags []Tags `json:"tags"` - Templatedisplaytext string `json:"templatedisplaytext"` - Templateid string `json:"templateid"` - Templatename string `json:"templatename"` - Type string `json:"type"` - Utilization string `json:"utilization"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualsize int64 `json:"virtualsize"` - Vmdisplayname string `json:"vmdisplayname"` - Vmname string `json:"vmname"` - Vmstate string `json:"vmstate"` - Vmtype string `json:"vmtype"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Encryptformat string `json:"encryptformat"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` + Volumecheckresult map[string]string `json:"volumecheckresult"` + Volumerepairresult map[string]string `json:"volumerepairresult"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type ResizeVolumeParams struct { @@ -3952,74 +4090,79 @@ func (s *VolumeService) ResizeVolume(p *ResizeVolumeParams) (*ResizeVolumeRespon } type ResizeVolumeResponse struct { - Account string `json:"account"` - Attached string `json:"attached"` - Chaininfo string `json:"chaininfo"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Created string `json:"created"` - Destroyed bool `json:"destroyed"` - Deviceid int64 `json:"deviceid"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - Diskioread int64 `json:"diskioread"` - Diskiowrite int64 `json:"diskiowrite"` - Diskkbsread int64 `json:"diskkbsread"` - Diskkbswrite int64 `json:"diskkbswrite"` - Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` - Diskofferingid string `json:"diskofferingid"` - Diskofferingname string `json:"diskofferingname"` - Displayvolume bool `json:"displayvolume"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externaluuid string `json:"externaluuid"` - Hasannotations bool `json:"hasannotations"` - Hypervisor string `json:"hypervisor"` - Id string `json:"id"` - Isextractable bool `json:"isextractable"` - Isodisplaytext string `json:"isodisplaytext"` - Isoid string `json:"isoid"` - Isoname string `json:"isoname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Path string `json:"path"` - Physicalsize int64 `json:"physicalsize"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Provisioningtype string `json:"provisioningtype"` - Quiescevm bool `json:"quiescevm"` - Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` - Serviceofferingid string `json:"serviceofferingid"` - Serviceofferingname string `json:"serviceofferingname"` - Size int64 `json:"size"` - Snapshotid string `json:"snapshotid"` - State string `json:"state"` - Status string `json:"status"` - Storage string `json:"storage"` - Storageid string `json:"storageid"` - Storagetype string `json:"storagetype"` - Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` - Tags []Tags `json:"tags"` - Templatedisplaytext string `json:"templatedisplaytext"` - Templateid string `json:"templateid"` - Templatename string `json:"templatename"` - Type string `json:"type"` - Utilization string `json:"utilization"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualsize int64 `json:"virtualsize"` - Vmdisplayname string `json:"vmdisplayname"` - Vmname string `json:"vmname"` - Vmstate string `json:"vmstate"` - Vmtype string `json:"vmtype"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Encryptformat string `json:"encryptformat"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` + Volumecheckresult map[string]string `json:"volumecheckresult"` + Volumerepairresult map[string]string `json:"volumerepairresult"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type UpdateVolumeParams struct { @@ -4037,6 +4180,10 @@ func (p *UpdateVolumeParams) toURLValues() url.Values { if v, found := p.p["customid"]; found { u.Set("customid", v.(string)) } + if v, found := p.p["deleteprotection"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("deleteprotection", vv) + } if v, found := p.p["displayvolume"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("displayvolume", vv) @@ -4101,6 +4248,27 @@ func (p *UpdateVolumeParams) GetCustomid() (string, bool) { return value, ok } +func (p *UpdateVolumeParams) SetDeleteprotection(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["deleteprotection"] = v +} + +func (p *UpdateVolumeParams) ResetDeleteprotection() { + if p.p != nil && p.p["deleteprotection"] != nil { + delete(p.p, "deleteprotection") + } +} + +func (p *UpdateVolumeParams) GetDeleteprotection() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["deleteprotection"].(bool) + return value, ok +} + func (p *UpdateVolumeParams) SetDisplayvolume(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4271,74 +4439,79 @@ func (s *VolumeService) UpdateVolume(p *UpdateVolumeParams) (*UpdateVolumeRespon } type UpdateVolumeResponse struct { - Account string `json:"account"` - Attached string `json:"attached"` - Chaininfo string `json:"chaininfo"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Created string `json:"created"` - Destroyed bool `json:"destroyed"` - Deviceid int64 `json:"deviceid"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - Diskioread int64 `json:"diskioread"` - Diskiowrite int64 `json:"diskiowrite"` - Diskkbsread int64 `json:"diskkbsread"` - Diskkbswrite int64 `json:"diskkbswrite"` - Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` - Diskofferingid string `json:"diskofferingid"` - Diskofferingname string `json:"diskofferingname"` - Displayvolume bool `json:"displayvolume"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externaluuid string `json:"externaluuid"` - Hasannotations bool `json:"hasannotations"` - Hypervisor string `json:"hypervisor"` - Id string `json:"id"` - Isextractable bool `json:"isextractable"` - Isodisplaytext string `json:"isodisplaytext"` - Isoid string `json:"isoid"` - Isoname string `json:"isoname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Path string `json:"path"` - Physicalsize int64 `json:"physicalsize"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Provisioningtype string `json:"provisioningtype"` - Quiescevm bool `json:"quiescevm"` - Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` - Serviceofferingid string `json:"serviceofferingid"` - Serviceofferingname string `json:"serviceofferingname"` - Size int64 `json:"size"` - Snapshotid string `json:"snapshotid"` - State string `json:"state"` - Status string `json:"status"` - Storage string `json:"storage"` - Storageid string `json:"storageid"` - Storagetype string `json:"storagetype"` - Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` - Tags []Tags `json:"tags"` - Templatedisplaytext string `json:"templatedisplaytext"` - Templateid string `json:"templateid"` - Templatename string `json:"templatename"` - Type string `json:"type"` - Utilization string `json:"utilization"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualsize int64 `json:"virtualsize"` - Vmdisplayname string `json:"vmdisplayname"` - Vmname string `json:"vmname"` - Vmstate string `json:"vmstate"` - Vmtype string `json:"vmtype"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Encryptformat string `json:"encryptformat"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` + Volumecheckresult map[string]string `json:"volumecheckresult"` + Volumerepairresult map[string]string `json:"volumerepairresult"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type UploadVolumeParams struct { @@ -4641,74 +4814,79 @@ func (s *VolumeService) UploadVolume(p *UploadVolumeParams) (*UploadVolumeRespon } type UploadVolumeResponse struct { - Account string `json:"account"` - Attached string `json:"attached"` - Chaininfo string `json:"chaininfo"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Created string `json:"created"` - Destroyed bool `json:"destroyed"` - Deviceid int64 `json:"deviceid"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - Diskioread int64 `json:"diskioread"` - Diskiowrite int64 `json:"diskiowrite"` - Diskkbsread int64 `json:"diskkbsread"` - Diskkbswrite int64 `json:"diskkbswrite"` - Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` - Diskofferingid string `json:"diskofferingid"` - Diskofferingname string `json:"diskofferingname"` - Displayvolume bool `json:"displayvolume"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externaluuid string `json:"externaluuid"` - Hasannotations bool `json:"hasannotations"` - Hypervisor string `json:"hypervisor"` - Id string `json:"id"` - Isextractable bool `json:"isextractable"` - Isodisplaytext string `json:"isodisplaytext"` - Isoid string `json:"isoid"` - Isoname string `json:"isoname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Path string `json:"path"` - Physicalsize int64 `json:"physicalsize"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Provisioningtype string `json:"provisioningtype"` - Quiescevm bool `json:"quiescevm"` - Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` - Serviceofferingid string `json:"serviceofferingid"` - Serviceofferingname string `json:"serviceofferingname"` - Size int64 `json:"size"` - Snapshotid string `json:"snapshotid"` - State string `json:"state"` - Status string `json:"status"` - Storage string `json:"storage"` - Storageid string `json:"storageid"` - Storagetype string `json:"storagetype"` - Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` - Tags []Tags `json:"tags"` - Templatedisplaytext string `json:"templatedisplaytext"` - Templateid string `json:"templateid"` - Templatename string `json:"templatename"` - Type string `json:"type"` - Utilization string `json:"utilization"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualsize int64 `json:"virtualsize"` - Vmdisplayname string `json:"vmdisplayname"` - Vmname string `json:"vmname"` - Vmstate string `json:"vmstate"` - Vmtype string `json:"vmtype"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Encryptformat string `json:"encryptformat"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` + Volumecheckresult map[string]string `json:"volumecheckresult"` + Volumerepairresult map[string]string `json:"volumerepairresult"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } type ChangeOfferingForVolumeParams struct { @@ -4942,72 +5120,77 @@ func (s *VolumeService) ChangeOfferingForVolume(p *ChangeOfferingForVolumeParams } type ChangeOfferingForVolumeResponse struct { - Account string `json:"account"` - Attached string `json:"attached"` - Chaininfo string `json:"chaininfo"` - Clusterid string `json:"clusterid"` - Clustername string `json:"clustername"` - Created string `json:"created"` - Destroyed bool `json:"destroyed"` - Deviceid int64 `json:"deviceid"` - DiskBytesReadRate int64 `json:"diskBytesReadRate"` - DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` - DiskIopsReadRate int64 `json:"diskIopsReadRate"` - DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` - Diskioread int64 `json:"diskioread"` - Diskiowrite int64 `json:"diskiowrite"` - Diskkbsread int64 `json:"diskkbsread"` - Diskkbswrite int64 `json:"diskkbswrite"` - Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` - Diskofferingid string `json:"diskofferingid"` - Diskofferingname string `json:"diskofferingname"` - Displayvolume bool `json:"displayvolume"` - Domain string `json:"domain"` - Domainid string `json:"domainid"` - Externaluuid string `json:"externaluuid"` - Hasannotations bool `json:"hasannotations"` - Hypervisor string `json:"hypervisor"` - Id string `json:"id"` - Isextractable bool `json:"isextractable"` - Isodisplaytext string `json:"isodisplaytext"` - Isoid string `json:"isoid"` - Isoname string `json:"isoname"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Maxiops int64 `json:"maxiops"` - Miniops int64 `json:"miniops"` - Name string `json:"name"` - Path string `json:"path"` - Physicalsize int64 `json:"physicalsize"` - Podid string `json:"podid"` - Podname string `json:"podname"` - Project string `json:"project"` - Projectid string `json:"projectid"` - Provisioningtype string `json:"provisioningtype"` - Quiescevm bool `json:"quiescevm"` - Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` - Serviceofferingid string `json:"serviceofferingid"` - Serviceofferingname string `json:"serviceofferingname"` - Size int64 `json:"size"` - Snapshotid string `json:"snapshotid"` - State string `json:"state"` - Status string `json:"status"` - Storage string `json:"storage"` - Storageid string `json:"storageid"` - Storagetype string `json:"storagetype"` - Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` - Tags []Tags `json:"tags"` - Templatedisplaytext string `json:"templatedisplaytext"` - Templateid string `json:"templateid"` - Templatename string `json:"templatename"` - Type string `json:"type"` - Utilization string `json:"utilization"` - Virtualmachineid string `json:"virtualmachineid"` - Virtualsize int64 `json:"virtualsize"` - Vmdisplayname string `json:"vmdisplayname"` - Vmname string `json:"vmname"` - Vmstate string `json:"vmstate"` - Vmtype string `json:"vmtype"` - Zoneid string `json:"zoneid"` - Zonename string `json:"zonename"` + Account string `json:"account"` + Attached string `json:"attached"` + Chaininfo string `json:"chaininfo"` + Clusterid string `json:"clusterid"` + Clustername string `json:"clustername"` + Created string `json:"created"` + Deleteprotection bool `json:"deleteprotection"` + Destroyed bool `json:"destroyed"` + Deviceid int64 `json:"deviceid"` + DiskBytesReadRate int64 `json:"diskBytesReadRate"` + DiskBytesWriteRate int64 `json:"diskBytesWriteRate"` + DiskIopsReadRate int64 `json:"diskIopsReadRate"` + DiskIopsWriteRate int64 `json:"diskIopsWriteRate"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Diskofferingdisplaytext string `json:"diskofferingdisplaytext"` + Diskofferingid string `json:"diskofferingid"` + Diskofferingname string `json:"diskofferingname"` + Displayvolume bool `json:"displayvolume"` + Domain string `json:"domain"` + Domainid string `json:"domainid"` + Domainpath string `json:"domainpath"` + Encryptformat string `json:"encryptformat"` + Externaluuid string `json:"externaluuid"` + Hasannotations bool `json:"hasannotations"` + Hypervisor string `json:"hypervisor"` + Id string `json:"id"` + Isextractable bool `json:"isextractable"` + Isodisplaytext string `json:"isodisplaytext"` + Isoid string `json:"isoid"` + Isoname string `json:"isoname"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Maxiops int64 `json:"maxiops"` + Miniops int64 `json:"miniops"` + Name string `json:"name"` + Path string `json:"path"` + Physicalsize int64 `json:"physicalsize"` + Podid string `json:"podid"` + Podname string `json:"podname"` + Project string `json:"project"` + Projectid string `json:"projectid"` + Provisioningtype string `json:"provisioningtype"` + Quiescevm bool `json:"quiescevm"` + Serviceofferingdisplaytext string `json:"serviceofferingdisplaytext"` + Serviceofferingid string `json:"serviceofferingid"` + Serviceofferingname string `json:"serviceofferingname"` + Size int64 `json:"size"` + Snapshotid string `json:"snapshotid"` + State string `json:"state"` + Status string `json:"status"` + Storage string `json:"storage"` + Storageid string `json:"storageid"` + Storagetype string `json:"storagetype"` + Supportsstoragesnapshot bool `json:"supportsstoragesnapshot"` + Tags []Tags `json:"tags"` + Templatedisplaytext string `json:"templatedisplaytext"` + Templateid string `json:"templateid"` + Templatename string `json:"templatename"` + Type string `json:"type"` + Utilization string `json:"utilization"` + Virtualmachineid string `json:"virtualmachineid"` + Virtualsize int64 `json:"virtualsize"` + Vmdisplayname string `json:"vmdisplayname"` + Vmname string `json:"vmname"` + Vmstate string `json:"vmstate"` + Vmtype string `json:"vmtype"` + Volumecheckresult map[string]string `json:"volumecheckresult"` + Volumerepairresult map[string]string `json:"volumerepairresult"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` } diff --git a/cloudstack/ZoneService.go b/cloudstack/ZoneService.go index 954c5c3a..24c14527 100644 --- a/cloudstack/ZoneService.go +++ b/cloudstack/ZoneService.go @@ -469,6 +469,7 @@ func (s *ZoneService) CreateZone(p *CreateZoneParams) (*CreateZoneResponse, erro type CreateZoneResponse struct { Allocationstate string `json:"allocationstate"` Allowuserspecifyvrmtu bool `json:"allowuserspecifyvrmtu"` + Asnrange string `json:"asnrange"` Capacity []CreateZoneResponseCapacity `json:"capacity"` Description string `json:"description"` Dhcpprovider string `json:"dhcpprovider"` @@ -486,6 +487,8 @@ type CreateZoneResponse struct { Internaldns2 string `json:"internaldns2"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` + Ismultiarch bool `json:"ismultiarch"` + Isnsxenabled bool `json:"isnsxenabled"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Localstorageenabled bool `json:"localstorageenabled"` @@ -510,6 +513,7 @@ type CreateZoneResponseCapacity struct { Percentused string `json:"percentused"` Podid string `json:"podid"` Podname string `json:"podname"` + Tag string `json:"tag"` Type int `json:"type"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` @@ -1750,6 +1754,7 @@ type ListZonesResponse struct { type Zone struct { Allocationstate string `json:"allocationstate"` Allowuserspecifyvrmtu bool `json:"allowuserspecifyvrmtu"` + Asnrange string `json:"asnrange"` Capacity []ZoneCapacity `json:"capacity"` Description string `json:"description"` Dhcpprovider string `json:"dhcpprovider"` @@ -1767,6 +1772,8 @@ type Zone struct { Internaldns2 string `json:"internaldns2"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` + Ismultiarch bool `json:"ismultiarch"` + Isnsxenabled bool `json:"isnsxenabled"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Localstorageenabled bool `json:"localstorageenabled"` @@ -1791,6 +1798,7 @@ type ZoneCapacity struct { Percentused string `json:"percentused"` Podid string `json:"podid"` Podname string `json:"podname"` + Tag string `json:"tag"` Type int `json:"type"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` @@ -2220,6 +2228,7 @@ type ListZonesMetricsResponse struct { type ZonesMetric struct { Allocationstate string `json:"allocationstate"` Allowuserspecifyvrmtu bool `json:"allowuserspecifyvrmtu"` + Asnrange string `json:"asnrange"` Capacity []ZonesMetricCapacity `json:"capacity"` Clusters string `json:"clusters"` Cpuallocated string `json:"cpuallocated"` @@ -2246,6 +2255,8 @@ type ZonesMetric struct { Internaldns2 string `json:"internaldns2"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` + Ismultiarch bool `json:"ismultiarch"` + Isnsxenabled bool `json:"isnsxenabled"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Localstorageenabled bool `json:"localstorageenabled"` @@ -2279,6 +2290,7 @@ type ZonesMetricCapacity struct { Percentused string `json:"percentused"` Podid string `json:"podid"` Podname string `json:"podname"` + Tag string `json:"tag"` Type int `json:"type"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` @@ -2821,6 +2833,7 @@ func (s *ZoneService) UpdateZone(p *UpdateZoneParams) (*UpdateZoneResponse, erro type UpdateZoneResponse struct { Allocationstate string `json:"allocationstate"` Allowuserspecifyvrmtu bool `json:"allowuserspecifyvrmtu"` + Asnrange string `json:"asnrange"` Capacity []UpdateZoneResponseCapacity `json:"capacity"` Description string `json:"description"` Dhcpprovider string `json:"dhcpprovider"` @@ -2838,6 +2851,8 @@ type UpdateZoneResponse struct { Internaldns2 string `json:"internaldns2"` Ip6dns1 string `json:"ip6dns1"` Ip6dns2 string `json:"ip6dns2"` + Ismultiarch bool `json:"ismultiarch"` + Isnsxenabled bool `json:"isnsxenabled"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Localstorageenabled bool `json:"localstorageenabled"` @@ -2862,6 +2877,7 @@ type UpdateZoneResponseCapacity struct { Percentused string `json:"percentused"` Podid string `json:"podid"` Podname string `json:"podname"` + Tag string `json:"tag"` Type int `json:"type"` Zoneid string `json:"zoneid"` Zonename string `json:"zonename"` diff --git a/generate/listApis.json b/generate/listApis.json index bbc5c768..48b52664 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -1,62 +1,26 @@ { "api": [ { - "description": "Lists the resource icon for the specified resource(s)", - "isasync": false, - "name": "listResourceIcon", + "description": "Creates VPC offering", + "isasync": true, + "name": "createVPCOffering", "params": [ { - "description": "type of the resource", + "description": "true if network offering is meant to be used for NSX, false otherwise.", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "name": "fornsx", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "description": "list of resources to upload the icon/image for", + "description": "the ID of the service offering for the VPC router appliance", "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - } - ], - "related": "", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "base64 representation of resource icon", - "name": "base64image", - "type": "string" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "resourceobjecttype" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.16.0.0" - }, - { - "description": "Creates VPC offering", - "isasync": true, - "name": "createVPCOffering", - "params": [ { "description": "the display text of the vpc offering, defaults to the 'name'", "length": 255, @@ -65,27 +29,26 @@ "type": "string" }, { - "description": "desired service capabilities as part of vpc offering", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "servicecapabilitylist", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "since": "4.4", - "type": "map" + "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", + "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", "length": 255, - "name": "serviceproviderlist", + "name": "internetprotocol", "required": false, - "type": "map" + "since": "4.17.0", + "type": "string" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "services supported by the vpc offering", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "supportedservices", "required": false, - "since": "4.13", "type": "list" }, { @@ -104,165 +67,99 @@ "type": "boolean" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, + "since": "4.13", "type": "list" }, { - "description": "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, - "name": "internetprotocol", + "name": "networkmode", "required": false, - "since": "4.17.0", + "since": "4.20.0", "type": "string" }, { - "description": "the ID of the service offering for the VPC router appliance", + "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "routingmode", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "string" }, { - "description": "services supported by the vpc offering", + "description": "true if network offering for NSX VPC offering supports Load balancer service.", "length": 255, - "name": "supportedservices", - "required": true, - "type": "list" - } - ], - "related": "updateVPCOffering,listVPCOfferings", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "name": "nsxsupportlb", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", - "type": "string" + "description": "true if the VPC offering supports choosing AS number", + "length": 255, + "name": "specifyasnumber", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "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": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "desired service capabilities as part of vpc offering", + "length": 255, + "name": "servicecapabilitylist", + "required": false, + "since": "4.4", + "type": "map" }, - {}, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "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" + } + ], + "related": "updateVPCOffering,listVPCOfferings", + "response": [ { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, + {}, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", - "type": "string" + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" }, { - "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": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { - "description": "the id of the vpc offering", - "name": "id", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { - "description": "the name of the vpc offering", - "name": "name", - "type": "string" + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" }, { "description": "state of the vpc offering. Can be Disabled/Enabled", @@ -270,18 +167,8 @@ "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": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", "type": "boolean" }, { @@ -289,243 +176,128 @@ "name": "internetprotocol", "type": "string" }, - {} - ] - }, - { - "description": "Creates a new Pod.", - "isasync": false, - "name": "createPod", - "params": [ { - "description": "the ending IP address for the Pod", - "length": 255, - "name": "endip", - "required": false, + "description": "the name of the vpc offering", + "name": "name", "type": "string" }, { - "description": "the Zone ID in which the Pod will be created", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the starting IP address for the Pod", - "length": 255, - "name": "startip", - "required": false, + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "the netmask for the Pod", - "length": 255, - "name": "netmask", - "required": false, + "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 gateway for the Pod", - "length": 255, - "name": "gateway", - "required": false, + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, + {}, { - "description": "Allocation state of this Pod for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, { - "description": "the name of the Pod", - "length": 255, - "name": "name", - "required": true, + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" - } - ], - "related": "listPods,updatePod,createManagementNetworkIpRange", - "response": [ + }, { - "description": "the capacity of the Pod", - "name": "capacity", + "description": "the list of supported services", + "name": "service", "response": [ { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "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" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity name", + "description": "the service name", "name": "name", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" } ], "type": "list" }, { - "description": "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": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", - "type": "list" - }, - { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of the Pod", - "name": "gateway", - "type": "string" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, - { - "description": "the 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 allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the name of the Pod", - "name": "name", - "type": "string" - }, - { - "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "the Zone ID of the Pod", - "name": "zoneid", - "type": "string" - }, - { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "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" - }, - {}, - {} + } ] }, { @@ -548,40 +320,40 @@ "type": "string" }, { - "description": "Network domain for the account's networks", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "networkdomain", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Creates the account under the specified role.", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "userid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "details for account used to store specific parameters", + "description": "Unique username.", "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" + "name": "username", + "required": true, + "type": "string" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "Network domain for the account's networks", "length": 255, - "name": "accounttype", + "name": "networkdomain", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Unique username.", + "description": "details for account used to store specific parameters", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "accountdetails", + "required": false, + "type": "map" }, { "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", @@ -591,92 +363,86 @@ "type": "string" }, { - "description": "Creates the user under the specified domain.", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "accounttype", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Creates the account under the specified role.", "length": 255, - "name": "userid", + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" } ], "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ - {}, - { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "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", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { @@ -685,70 +451,95 @@ "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the id of the account", + "name": "id", "type": "string" }, {}, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "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 projects the account can own", - "name": "projectlimit", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", "type": "list" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { "description": "the total number of networks owned by account", @@ -756,24 +547,19 @@ "type": "long" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the state of the account", - "name": "state", - "type": "string" - }, - { - "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": "details for the account", @@ -781,64 +567,50 @@ "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 owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "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 total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "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) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "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", @@ -846,102 +618,87 @@ "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "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", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, { "description": "the account ID of the user", "name": "accountid", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user email address", + "name": "email", "type": "string" }, { @@ -954,44 +711,44 @@ "name": "account", "type": "string" }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, { "description": "the domain name of the user", "name": "domain", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the user email address", - "name": "email", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -1004,80 +761,61 @@ "name": "is2famandated", "type": "boolean" }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, { "description": "the api key of the user", "name": "apikey", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { "description": "the account type of the user", "name": "accounttype", "type": "integer" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" } ], "type": "list" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Safely removes raw records from cloud_usage table", - "isasync": false, - "name": "removeRawUsageRecords", - "params": [ - { - "description": "Specify the number of days (greater than zero) to remove records that are older than those number of days from today. For example, specifying 10 would result in removing all the records created before 10 days from today", - "length": 255, - "name": "interval", - "required": true, - "type": "integer" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name 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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" } ], - "since": "4.6.0" + "since": "4.2.0" }, { "description": "Copies an iso from one zone to another.", @@ -1085,9 +823,9 @@ "name": "copyIso", "params": [ { - "description": "ID of the zone the template is being copied to.", + "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", "length": 255, - "name": "destzoneid", + "name": "sourcezoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" @@ -1101,55 +839,70 @@ "type": "uuid" }, { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "description": "ID of the zone the template is being copied to.", "length": 255, - "name": "destzoneids", + "name": "destzoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", + "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", "length": 255, - "name": "sourcezoneid", + "name": "destzoneids", "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "uuid" + "type": "list" } ], "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the template name", + "name": "name", "type": "string" }, - {}, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + {}, { "description": "the list of resource tags associated", "name": "tags", @@ -1159,29 +912,39 @@ "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -1195,77 +958,58 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, - { - "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 template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "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 template", - "name": "details", - "type": "map" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the name of the domain to which the template belongs", @@ -1273,13 +1017,13 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { @@ -1288,73 +1032,53 @@ "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the project name of the template", - "name": "project", - "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 userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the template name", - "name": "name", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "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", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { @@ -1363,9 +1087,14 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { "description": "the format of the template.", @@ -1373,131 +1102,101 @@ "type": "imageformat" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the status of the template", - "name": "status", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "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 template display text", - "name": "displaytext", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, - {}, { "description": "the URL which the template/iso is registered from", "name": "url", "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "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" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" - } - ] - }, - { - "description": "Issues and propagates client certificate on a connected host/agent using configured CA plugin", - "isasync": true, - "name": "provisionCertificate", - "params": [ + }, { - "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", - "required": true, - "type": "uuid" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "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 physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", - "length": 255, - "name": "provider", - "required": false, + "description": "the account name to which the template belongs", + "name": "account", "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", + "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", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, - {} - ], - "since": "4.11.0" + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] }, { "description": "Deletes a autoscale vm profile.", @@ -1514,2147 +1213,1613 @@ } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { - "description": "Lists VM metrics", + "description": "List storage pools compatible with a vSphere storage policy", "isasync": false, - "name": "listVirtualMachinesMetrics", + "name": "listVsphereStoragePolicyCompatiblePools", "params": [ { - "description": "list vms by iso", + "description": "List by keyword", "length": 255, - "name": "isoid", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "ID of the storage policy", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "policyid", + "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", "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 storage ID where vm's volumes belong to", + "description": "ID of the zone", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "", "length": 255, - "name": "displayvm", + "name": "page", "required": false, - "since": "4.4", + "type": "integer" + } + ], + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "response": [ + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", - "length": 255, - "name": "name", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", - "length": 255, - "name": "userdata", - "required": false, - "since": "4.18.0.0", - "type": "boolean" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "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,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "since": "4.4", - "type": "list" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "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 ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", - "length": 255, - "name": "isvnf", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "list by the backup offering", - "length": 255, - "name": "backupofferingid", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, + {}, { - "description": "list vms by template", - "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "uuid" + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "description": "flag to display the resource icon for VMs", - "length": 255, - "name": "showicon", - "required": false, - "since": "4.16.0.0", - "type": "boolean" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the security group ID", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", - "required": false, - "since": "4.15", - "type": "uuid" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the group ID", - "length": 255, - "name": "groupid", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", - "required": false, - "type": "uuid" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the host ID", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.", - "length": 255, + "description": "the state of the storage pool", "name": "state", - "required": false, - "type": "string" + "type": "storagepoolstatus" }, + {}, { - "description": "list vms by vpc", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "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,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "list vms by ssh keypair name", - "length": 255, - "name": "keypair", - "required": false, - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "uuid" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the ID of AutoScaling VM Group", - "length": 255, - "name": "autoscalevmgroupid", - "related": "createAutoScaleVmGroup,disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": false, - "since": "4.18.0", - "type": "uuid" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the pod ID", - "length": 255, + "description": "the Pod ID of the storage pool", "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "list vms by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", - "required": false, - "type": "uuid" - }, + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + } + ] + }, + { + "description": "Reboots a system VM.", + "isasync": true, + "name": "rebootSystemVm", + "params": [ { - "description": "list by the service offering", + "description": "The ID of the system virtual machine", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.4", + "name": "id", + "related": "destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, "type": "uuid" }, { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", - "length": 255, - "name": "accumulate", - "required": false, - "since": "4.17.0", - "type": "boolean" - }, - { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "Force reboot the system VM (System VM is Stopped and then Started)", "length": 255, - "name": "haenable", + "name": "forced", "required": false, - "since": "4.15", + "since": "4.16.0", "type": "boolean" } ], - "related": "listVirtualMachinesMetrics", + "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the state of the system VM", + "name": "state", "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": "the group name of the virtual machine", - "name": "group", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, - {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the service offering of the system 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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total memory capacity in GiB", - "name": "memorytotal", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag 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" - } - ], - "type": "set" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the 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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "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": "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 project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, + {}, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "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 domain in which the virtual machine exists", - "name": "domain", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" }, { - "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": "List dedicated zones.", + "isasync": false, + "name": "listDedicatedZones", + "params": [ + { + "description": "the ID of the Zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "disk read in MiB", - "name": "diskread", + "description": "list dedicated zones by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", + "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" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "dedicateZone", + "response": [ { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the type of the nic", - "name": "type", - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "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 traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - } - ], - "type": "set" + "description": "the Name of the Zone", + "name": "zonename", + "type": "string" }, + {}, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the 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": "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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 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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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 domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the 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 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" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "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" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - } - ], - "type": "set" + "description": "the domain ID to which the Zone is dedicated", + "name": "domainid", + "type": "string" }, + {}, { - "description": "disk write in MiB", - "name": "diskwrite", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", "type": "string" - }, + } + ] + }, + { + "description": "Lists the pools of elastistor", + "isasync": false, + "name": "listElastistorPool", + "params": [ { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the ID of the Pool", + "length": 255, + "name": "id", + "required": false, + "type": "long" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" + "description": "the current available space of the pool", + "name": "size", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, + {}, { - "description": "network write in MiB", - "name": "networkwrite", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "available iops of the pool", + "name": "maxiops", "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the state of the storage pool", + "name": "state", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "default gateway of the pool", + "name": "gateway", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "controller of the pool", + "name": "controllerid", "type": "string" + } + ] + }, + { + "description": "Change the BGP peers for a network.", + "isasync": true, + "name": "changeBgpPeersForNetwork", + "params": [ + { + "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", + "length": 255, + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForNetwork,changeBgpPeersForVpc", + "required": false, + "type": "list" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "UUID of the network which the Bgp Peers are associated to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + } + ], + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", + "response": [ + { + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "network read in MiB", - "name": "networkread", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the account associated with the virtual machine", + "description": "the account of the bgp peer", "name": "account", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" }, + {} + ], + "since": "4.20.0" + }, + { + "description": "list Tungsten-Fabric LB health monitor", + "isasync": false, + "name": "listTungstenFabricLBHealthMonitor", + "params": [ { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of lb rule", + "length": 255, + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + } + ], + "related": "updateTungstenFabricLBHealthMonitor", + "response": [ + { + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" + }, + { + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, + {}, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + { + "description": "the health monitor interval", + "name": "interval", + "type": "int" + }, {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the health monitor type", + "name": "type", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the health monitor ID", + "name": "id", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" + }, + { + "description": "the health monitor retry", + "name": "retry", + "type": "int" } ] }, { - "description": "Lists hosts.", - "isasync": false, - "name": "listHosts", + "description": "Deletes account from the project", + "isasync": true, + "name": "deleteAccountFromProject", "params": [ { - "description": "the Zone ID for the host", + "description": "name of the account to be removed from the project", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "name": "account", + "required": true, + "type": "string" }, { - "description": "", + "description": "ID of the project to remove the account from", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "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": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "lists hosts existing in particular cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "uuid" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the Pod ID for the host", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "Updates the information about Guest OS", + "isasync": true, + "name": "updateGuestOs", + "params": [ + { + "description": "UUID of the Guest OS", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, + "name": "id", + "related": "listOsTypes,addGuestOs,updateGuestOs", + "required": true, "type": "uuid" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "Unique display name for Guest OS", "length": 255, - "name": "hahost", - "required": false, - "type": "boolean" + "name": "osdisplayname", + "required": true, + "type": "string" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "Map of (key/value pairs)", "length": 255, "name": "details", "required": false, - "type": "list" + "type": "map" }, { - "description": "", + "description": "whether this guest OS is available for end users", "length": 255, - "name": "page", + "name": "forDisplay", "required": false, - "type": "integer" + "type": "boolean" + } + ], + "related": "listOsTypes,addGuestOs", + "response": [ + { + "description": "the name/description of the OS type", + "name": "description", + "type": "string" }, + {}, + {}, { - "description": "list hosts for which out-of-band management is enabled", - "length": 255, - "name": "outofbandmanagementenabled", - "required": false, + "description": "the name of the OS category", + "name": "oscategoryname", + "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 host type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the OS type", + "name": "name", + "type": "string" + }, + { + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the OS type", + "name": "id", + "type": "string" + } + ], + "since": "4.4.0" + }, + { + "description": "Lists all guest vlans", + "isasync": false, + "name": "listGuestVlans", + "params": [ + { + "description": "limits search results to allocated guest vlan. false by default.", "length": 255, - "name": "type", + "name": "allocatedonly", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "List by keyword", "length": 255, - "name": "resourcestate", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the state of the host", + "description": "list guest vlan by zone", "length": 255, - "name": "state", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the host", + "description": "list guest vlan by vnet", "length": 255, - "name": "name", + "name": "vnet", "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", + "description": "list guest vlan by physical network", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "the id of the host", + "description": "", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "list guest vlan by id", "length": 255, - "name": "keyword", + "name": "id", "required": false, - "type": "string" + "type": "long" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "related": "", "response": [ { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the project name of the guest VLAN range", + "name": "project", "type": "string" }, + {}, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the list of networks who use this guest VLAN", + "name": "network", + "type": "list" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the guest VLAN", + "name": "vlan", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the domain ID of the guest VLAN range", + "name": "domainid", "type": "string" }, + {}, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the zone ID of the guest VLAN range", + "name": "zoneid", "type": "string" }, - {}, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", + "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the project id of the guest VLAN range", + "name": "projectid", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the zone name of the guest VLAN range", + "name": "zonename", "type": "string" }, { - "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the guest VLAN id", + "name": "id", "type": "long" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network name of the guest VLAN range", + "name": "physicalnetworkname", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "date the guest VLAN was taken", + "name": "taken", + "type": "date" }, { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" - }, + } + ], + "since": "4.17.0" + }, + { + "description": "Updates resource limits for an account or domain.", + "isasync": false, + "name": "updateResourceLimit", + "params": [ { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": " Maximum resource limit.", + "length": 255, + "name": "max", + "required": false, "type": "long" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "length": 255, + "name": "resourcetype", + "required": true, + "type": "integer" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "Tag for the resource type", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, + "description": "Update resource limits for project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + } + ], + "related": "listResourceLimits", + "response": [ { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the domain name of the resource limit", + "name": "domain", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" }, - { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the domain ID of the resource limit", + "name": "domainid", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the project name of the resource limit", + "name": "project", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", + "name": "resourcetype", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "The tag for the resource limit", + "name": "tag", + "type": "string" }, + {}, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "path of the domain to which the resource limit belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, + "description": "the account of the resource limit", + "name": "account", + "type": "string" + } + ] + }, + { + "description": "Deletes a static route", + "isasync": true, + "name": "deleteStaticRoute", + "params": [ { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, + "description": "the ID of the static route", + "length": 255, + "name": "id", + "related": "createStaticRoute,listStaticRoutes", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the host version", - "name": "version", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "get load balancer certificate", + "isasync": false, + "name": "getLoadBalancerSslCertificate", + "params": [ { - "description": "the ID of the host", + "description": "the ID of Lb", + "length": 255, "name": "id", - "type": "string" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, + "related": "getLoadBalancerSslCertificate", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the Pod name of the host", - "name": "podname", + "description": "chain", + "name": "chain", "type": "string" }, - {}, { - "description": "events available for the host", - "name": "events", + "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 after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "crt", + "name": "crt", "type": "string" }, + {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "key", + "name": "key", "type": "string" } ] }, { - "description": "Deletes a storage pool.", - "isasync": false, - "name": "deleteStoragePool", + "description": "Destroys a l2tp/ipsec remote access vpn", + "isasync": true, + "name": "deleteRemoteAccessVpn", "params": [ { - "description": "Storage pool id", + "description": "public ip address id of the vpn server", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities,listVsphereStoragePolicyCompatiblePools", + "name": "publicipid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" - }, - { - "description": "Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { - "description": "List storage pools compatible with a vSphere storage policy", - "isasync": false, - "name": "listVsphereStoragePolicyCompatiblePools", + "description": "Start rolling maintenance", + "isasync": true, + "name": "startRollingMaintenance", "params": [ { - "description": "", + "description": "the IDs of the clusters to start maintenance on", "length": 255, - "name": "page", + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "integer" + "type": "list" }, { - "description": "List by keyword", + "description": "the command to execute while hosts are on maintenance", "length": 255, - "name": "keyword", + "name": "payload", "required": false, "type": "string" }, { - "description": "ID of the zone", + "description": "optional operation timeout (in seconds) that overrides the global timeout setting", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "timeout", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "ID of the storage policy", + "description": "the IDs of the hosts to start maintenance on", "length": 255, - "name": "policyid", - "related": "importVsphereStoragePolicies,listVsphereStoragePolicies", + "name": "hostids", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "", + "description": "if rolling mechanism should continue in case of an error", "length": 255, - "name": "pagesize", + "name": "forced", "required": false, - "type": "integer" - } - ], - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod ID of the storage pool", - "name": "podid", - "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 total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "type": "boolean" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the IDs of the pods to start maintenance on", + "length": 255, + "name": "podids", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "list" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, + "description": "the IDs of the zones to start maintenance on", + "length": 255, + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" + } + ], + "related": "", + "response": [ { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the hosts skipped", + "name": "hostsskipped", + "response": [ + { + "description": "the ID of the skipped host", + "name": "hostid", + "type": "string" + }, + { + "description": "the reason to skip the host", + "name": "reason", + "type": "string" + }, + { + "description": "the name of the skipped host", + "name": "hostname", + "type": "string" + } + ], + "type": "list" }, {}, { - "description": "the storage pool path", - "name": "path", - "type": "string" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the hosts updated", + "name": "hostsupdated", + "response": [ + { + "description": "end date of the update on the host", + "name": "enddate", + "type": "string" + }, + { + "description": "the name of the updated host", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the updated host", + "name": "hostid", + "type": "string" + }, + { + "description": "start date of the update on the host", + "name": "startdate", + "type": "string" + }, + { + "description": "output of the maintenance script on the host", + "name": "output", + "type": "string" + } + ], + "type": "list" }, + {}, { - "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": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "indicates if the rolling maintenance operation was successful", + "name": "success", "type": "boolean" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "Storage provider for this pool", - "name": "provider", + "description": "in case of failure, details are displayed", + "name": "details", "type": "string" + } + ] + }, + { + "description": "list Tungsten-Fabric application policy set", + "isasync": false, + "name": "listTungstenFabricApplicationPolicySet", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createTungstenFabricApplicationPolicySet", + "response": [ { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, + {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" }, - {}, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -3662,442 +2827,856 @@ "type": "integer" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", "type": "string" - } + }, + {} ] }, { - "description": "Deletes an existing guest network IPv6 prefix.", + "description": "Updates network ACL list", "isasync": true, - "name": "deleteGuestNetworkIpv6Prefix", + "name": "updateNetworkACLList", "params": [ { - "description": "Id of the guest network IPv6 prefix", + "description": "Name of the network ACL list", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "an optional field, whether to the display the list to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the network ACL", "length": 255, "name": "id", - "related": "createGuestNetworkIpv6Prefix,listGuestNetworkIpv6Prefixes", + "related": "createNetworkACLList,listNetworkACLLists", "required": true, "type": "uuid" + }, + { + "description": "Description of the network ACL list", + "length": 255, + "name": "description", + "required": false, + "type": "string" } ], "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], - "since": "4.17.0.0" + "since": "4.4" }, { - "description": "Updates a storage pool.", - "isasync": false, - "name": "updateStoragePool", + "description": "Restore a VM to original template/ISO or new template/ISO", + "isasync": true, + "name": "restoreVirtualMachine", "params": [ { - "description": "the URL of the storage pool", - "length": 255, - "name": "url", - "required": false, - "since": "4.19.0", - "type": "string" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "length": 255, - "name": "istagarule", - "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": "false to disable the pool for allocation of new volumes, true to enable it back.", + "description": "Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", "length": 255, - "name": "enabled", + "name": "rootdisksize", "required": false, - "type": "boolean" + "since": "4.19.1", + "type": "long" }, { - "description": "the details for the storage pool", + "description": "used to specify the custom parameters", "length": 255, "name": "details", "required": false, - "since": "4.19.0", + "since": "4.19.1", "type": "map" }, { - "description": "Change the name of the storage pool", + "description": "Override root volume's diskoffering.", "length": 255, - "name": "name", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, - "since": "4.15", - "type": "string" + "since": "4.19.1", + "type": "uuid" }, { - "description": "comma-separated list of tags for the storage pool", + "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO", "length": 255, - "name": "tags", + "name": "templateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "Optional field to expunge old root volume after restore.", "length": 255, - "name": "capacitybytes", + "name": "expunge", "required": false, - "type": "long" + "since": "4.19.1", + "type": "boolean" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "Virtual Machine ID", "length": 255, - "name": "capacityiops", - "required": false, - "type": "long" + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" } ], - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "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": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, + {}, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "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 Pod name of the storage pool", - "name": "podname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, + {}, { - "description": "the name of the storage pool", - "name": "name", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the storage pool type", - "name": "type", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, - {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - {}, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Reboots a system VM.", - "isasync": true, - "name": "rebootSystemVm", - "params": [ - { - "description": "The ID of the system virtual machine", - "length": 255, - "name": "id", - "related": "destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", - "required": true, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Force reboot the system VM (System VM is Stopped and then Started)", - "length": 255, - "name": "forced", - "required": false, - "since": "4.16.0", - "type": "boolean" - } - ], - "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", - "response": [ + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, - {}, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the 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": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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 domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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 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", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + } + ], + "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 virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + } + ], + "type": "set" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the name of userdata used for the VM", + "name": "userdataname", "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", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "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 account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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": "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" + } + ], + "type": "set" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", @@ -4105,222 +3684,427 @@ "type": "boolean" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "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 control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", - "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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 gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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": "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "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" + } + ], + "type": "set" }, - {} - ] - }, - { - "description": "Lists Tungsten-Fabric tags", - "isasync": false, - "name": "listTungstenFabricTag", - "params": [ { - "description": "the uuid of Tungsten-Fabric network", - "length": 255, - "name": "networkuuid", - "required": false, + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": false, - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric nic", - "length": 255, - "name": "nicuuid", - "required": false, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag", - "length": 255, - "name": "taguuid", - "required": false, + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": false, + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric vm", - "length": 255, - "name": "vmuuid", - "required": false, - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the ID of zone", - "length": 255, + "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "createTungstenFabricTag,applyTungstenFabricTag,removeTungstenFabricTag", - "response": [ - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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 ID of the affinity group", + "name": "id", + "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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" - }, + } + ], + "since": "3.0.0" + }, + { + "description": " delete a nicira nvp device", + "isasync": true, + "name": "deleteNiciraNvpDevice", + "params": [ { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" - }, - {}, + "description": "Nicira device ID", + "length": 255, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "true if 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": "Tungsten-Fabric tag name", - "name": "name", + "description": "any text associated with the 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": "Import LDAP users", + "description": "List ucs blades", "isasync": false, - "name": "importLdapUsers", + "name": "listUcsBlades", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -4330,84 +4114,31 @@ "type": "integer" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "ucs manager id", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "List by keyword", "length": 255, - "name": "accounttype", - "required": false, - "type": "integer" - }, - { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" - }, - { - "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": "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,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", + "name": "keyword", "required": false, "type": "string" } ], - "related": "searchLdap,listLdapUsers", + "related": "associateUcsProfileToBlade", "response": [ { - "description": "The user's firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "The user's email", - "name": "email", - "type": "string" - }, - { - "description": "The user's username", - "name": "username", + "description": "ucs manager id", + "name": "ucsmanagerid", "type": "string" }, { - "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", - "name": "conflictingusersource", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" }, { @@ -4417,72 +4148,85 @@ }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, { - "description": "The user's lastname", - "name": "lastname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, { - "description": "The user's principle", - "name": "principal", + "description": "ucs blade id", + "name": "id", "type": "string" }, {} - ], - "since": "4.3.0" + ] }, { - "description": "Moves a domain and its children to a new parent domain.", - "isasync": false, - "name": "moveDomain", + "description": "Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user", + "isasync": true, + "name": "notifyBaremetalProvisionDone", "params": [ { - "description": "The ID of the new parent domain of the domain to be moved.", - "length": 255, - "name": "parentdomainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": true, - "type": "uuid" - }, - { - "description": "The ID of the domain to be moved.", + "description": "mac of the nic used for provision", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "mac", "required": true, - "type": "uuid" + "type": "object" } ], - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", "response": [ + {}, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "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": "Get Volume Snapshot Details", + "isasync": false, + "name": "getVolumeSnapshotDetails", + "params": [ + { + "description": "CloudStack Snapshot UUID", + "length": 255, + "name": "snapshotid", + "required": true, + "type": "string" + } + ], + "related": "getVolumeiScsiName", + "response": [ {}, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", "type": "string" }, { @@ -4490,319 +4234,349 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Updates a host.", + "isasync": false, + "name": "updateHost", + "params": [ + { + "description": "Change the name of host", + "length": 255, + "name": "name", + "required": false, + "since": "4.15", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "Add an annotation to this host", + "length": 255, + "name": "annotation", + "required": false, + "since": "4.11", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the new uri for the secondary storage: nfs://host/path", + "length": 255, + "name": "url", + "required": false, "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "list of tags to be added to the host", + "length": 255, + "name": "hosttags", + "required": false, + "type": "list" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "type": "string" + "description": "the id of Os category to update the host with", + "length": 255, + "name": "oscategoryid", + "related": "listOsCategories", + "required": false, + "type": "uuid" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" + "description": "the ID of the host to update", + "length": 255, + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "required": true, + "type": "uuid" }, { - "description": "the ID of the domain", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "length": 255, + "name": "istagarule", + "required": false, + "type": "boolean" + } + ], + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "response": [ + { + "description": "the ID of the host", "name": "id", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", - "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 state of the domain", - "name": "state", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "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 level of the domain", - "name": "level", - "type": "integer" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum 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": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the Pod name of the host", + "name": "podname", "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": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the name of the domain", - "name": "name", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, - {} - ], - "since": "4.19.0.0" - }, - { - "description": "List dedicated zones.", - "isasync": false, - "name": "listDedicatedZones", - "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the Zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list dedicated zones by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", - "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, + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the ID of the domain associated with the zone", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - } - ], - "related": "dedicateZone", - "response": [ - {}, - { - "description": "the Account Id to which the Zone is dedicated", - "name": "accountid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the domain ID to which the Zone is dedicated", - "name": "domainid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { @@ -4810,339 +4584,284 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "the Name of the Zone", - "name": "zonename", - "type": "string" - }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the zone", - "name": "affinitygroupid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" - } - ] - }, - { - "description": "Lists all available networks.", - "isasync": false, - "name": "listNetworks", - "params": [ - { - "description": "list networks by ID", - "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" }, { - "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": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "list networks by network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "true if network is system, false otherwise", - "length": 255, - "name": "issystem", - "required": false, + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "type": "integer" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", - "length": 255, - "name": "type", - "required": false, - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "list networks by restartRequired", - "length": 255, - "name": "restartrequired", - "required": false, + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, + {}, { - "description": "list networks available for VM deployment", - "length": 255, - "name": "canusefordeploy", - "required": false, - "type": "boolean" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "List networks by VPC", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the zone ID of the network", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "list networks by physical network id", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" + "description": "the CPU number of the host", + "name": "cpunumber", + "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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, + {}, { - "description": "possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared).", - "length": 255, - "name": "networkfilter", - "required": false, - "since": "4.17.0", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", - "length": 255, - "name": "acltype", - "required": false, + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "flag to display the resource icon for networks", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + } + ] + }, + { + "description": "Creates a egress firewall rule for a given network ", + "isasync": true, + "name": "createEgressFirewallRule", + "params": [ + { + "description": "the starting port of firewall rule", "length": 255, - "name": "showicon", + "name": "startport", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "type of the traffic", + "description": "the network id of the port forwarding rule", "length": 255, - "name": "traffictype", - "required": false, - "type": "string" + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "destcidrlist", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "the network belongs to VPC", + "description": "type of the icmp message being sent", "length": 255, - "name": "forvpc", + "name": "icmptype", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID or VID of the network", + "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "vlan", + "name": "cidrlist", "required": false, - "since": "4.17.0", - "type": "string" + "type": "list" }, { - "description": "true if need to list only networks which support specifying IP ranges", + "description": "the ending port of firewall rule", "length": 255, - "name": "specifyipranges", + "name": "endport", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List networks by associated networks. Only available if create a Shared network.", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "fordisplay", "required": false, - "since": "4.17.0", - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list networks supporting certain services", + "description": "type of firewallrule: system/user", "length": 255, - "name": "supportedservices", + "name": "type", "required": false, - "type": "list" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "error code for this icmp message", "length": 255, - "name": "tags", + "name": "icmpcode", "required": false, - "type": "map" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "protocol", + "required": true, + "type": "string" } ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ + {}, { - "description": "the name of the network", - "name": "name", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "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 starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the network's gateway", - "name": "gateway", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", + "description": "the ending port of firewall rule's port range", + "name": "endport", "type": "integer" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -5150,6 +4869,16 @@ "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", @@ -5161,584 +4890,551 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Lists security groups", + "isasync": false, + "name": "listSecurityGroups", + "params": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "list the security group by the id provided", + "length": 255, + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", + "required": false, + "type": "uuid" }, { - "description": "the project name of the address", - "name": "project", - "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,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "lists security groups by name", + "length": 255, + "name": "securitygroupname", + "required": false, "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "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 network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "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": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "state of the network", - "name": "state", - "type": "string" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "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": "related to what other network configuration", - "name": "related", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + } + ], + "related": "createSecurityGroup,updateSecurityGroup", + "response": [ { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "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 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 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "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 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": "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", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the owner of the network", + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "The external id of the network", - "name": "externalid", - "type": "string" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - }, - { - "description": "the list of services", - "name": "service", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the service name", - "name": "name", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the service provider name", - "name": "provider", + "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": "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": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the domain associated with the tag", + "name": "domain", "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": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the capability value", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", "name": "value", "type": "string" } ], - "type": "list" + "type": "set" } ], - "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": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "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", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, - {}, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "the id of the network", + "description": "the ID of the security group", "name": "id", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" - } - ] - }, - { - "description": "Lists the pools of elastistor", - "isasync": false, - "name": "listElastistorPool", - "params": [ - { - "description": "the ID of the Pool", - "length": 255, - "name": "id", - "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 current available space of the pool", - "name": "size", - "type": "long" + "description": "the description of the security group", + "name": "description", + "type": "string" }, { - "description": "the name of the storage pool", + "description": "the name of the security group", "name": "name", "type": "string" }, { - "description": "default gateway of the pool", - "name": "gateway", + "description": "the project name of the group", + "name": "project", "type": "string" }, - {}, - { - "description": "available iops of the pool", - "name": "maxiops", - "type": "long" - }, { - "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 state of the storage pool", - "name": "state", - "type": "string" - }, - { - "description": "the ID of the storage pool", - "name": "id", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, + {}, { - "description": "controller of the pool", - "name": "controllerid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, {} ] }, { - "description": "Releases an IP address from the account.", + "description": "Enables a role", "isasync": false, - "name": "releaseIpAddress", + "name": "enableRole", "params": [ { - "description": "the ID of the public IP address to release", + "description": "ID of the role", "length": 255, "name": "id", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "createRole,importRole,listRoles,updateRole", "required": true, "type": "uuid" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "4.17" - }, - { - "description": "Updates a management network IP range. Only allowed when no IPs are allocated.", - "isasync": true, - "name": "updatePodManagementNetworkIpRange", - "params": [ - { - "description": "The new starting IP address.", - "length": 255, - "name": "newstartip", - "required": false, - "type": "string" - }, - { - "description": "The new ending IP address.", - "length": 255, - "name": "newendip", - "required": false, - "type": "string" - }, - { - "description": "The current starting IP address.", - "length": 255, - "name": "currentstartip", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "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" - } - ], - "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } + }, + {} ], - "since": "4.16.0.0" + "since": "4.20.0" }, { - "description": "list Tungsten-Fabric LB health monitor", + "description": "List OAuth providers registered", "isasync": false, - "name": "listTungstenFabricLBHealthMonitor", + "name": "listOauthProvider", "params": [ { - "description": "the ID of lb rule", + "description": "Name of the provider", "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" + "name": "provider", + "required": false, + "type": "string" }, { "description": "", @@ -5747,6 +5443,14 @@ "required": false, "type": "integer" }, + { + "description": "the ID of the OAuth provider", + "length": 255, + "name": "id", + "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -5762,126 +5466,149 @@ "type": "string" } ], - "related": "updateTungstenFabricLBHealthMonitor", + "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", "response": [ + {}, { - "description": "the health monitor ID", - "name": "id", - "type": "long" + "description": "Client ID registered in the OAuth provider", + "name": "clientid", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, { - "description": "the health monitor retry", - "name": "retry", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the health monitor http method", - "name": "httpmethod", + "description": "ID of the provider", + "name": "id", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the health monitor UUID", - "name": "uuid", - "type": "string" + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" }, { - "description": "the health monitor url path", - "name": "urlpath", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, { - "description": "the health monitor expected code", - "name": "expectedcode", + "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": "Secret key registered in the OAuth provider", + "name": "secretkey", + "type": "string" }, { - "description": "the health monitor timeout", - "name": "timeout", - "type": "int" - }, + "description": "Name of the provider", + "name": "name", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Delete Service Package", + "isasync": false, + "name": "deleteServicePackageOffering", + "params": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, + "description": "the service offering ID", + "length": 255, + "name": "id", + "related": "registerNetscalerServicePackage,listRegisteredServicePackages", + "required": true, + "type": "string" + } + ], + "response": [ {}, { - "description": "the health monitor interval", - "name": "interval", - "type": "int" + "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the health monitor type", - "name": "type", + "description": "true if 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": "Updates firewall rule ", - "isasync": true, - "name": "updateFirewallRule", + "description": "Update a Shared FileSystem", + "isasync": false, + "name": "updateSharedFileSystem", "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", + "description": "the ID of the shared filesystem", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "createSharedFileSystem,listSharedFileSystems,updateSharedFileSystem,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "required": true, "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the name of the shared filesystem.", "length": 255, - "name": "fordisplay", + "name": "name", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" + }, + { + "description": "the description for the shared filesystem.", + "length": 255, + "name": "description", + "required": false, + "type": "string" } ], - "related": "createEgressFirewallRule,createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", + "related": "createSharedFileSystem,listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { @@ -5889,6 +5616,11 @@ "name": "value", "type": "string" }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", @@ -5900,558 +5632,649 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "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 account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "list" - }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "type": "set" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of the rule", - "name": "state", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "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", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" - } - ], - "since": "4.4" - }, - { - "description": "Return true if the plugin is enabled", - "isasync": false, - "name": "quotaIsEnabled", - "params": [], - "related": "", - "response": [ - { - "description": "is quota service enabled", - "name": "isenabled", - "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, - {} - ], - "since": "4.7.0" - }, - { - "description": "Deletes the registered OAuth provider", - "isasync": false, - "name": "deleteOauthProvider", - "params": [ - { - "description": "id of the OAuth provider to be deleted", - "length": 255, - "name": "id", - "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.19.0" - }, - { - "description": "Deletes account from the project", - "isasync": true, - "name": "deleteAccountFromProject", - "params": [ - { - "description": "name of the account to be removed from the project", - "length": 255, - "name": "account", - "required": true, + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, - { - "description": "ID of the project to remove the account from", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - } - ], - "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "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", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "List hypervisors", - "isasync": false, - "name": "listHypervisors", - "params": [ - { - "description": "the zone id for listing hypervisors.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "Hypervisor name", - "name": "name", - "type": "string" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, - {} - ] - }, - { - "description": "Updates the information about Guest OS", - "isasync": true, - "name": "updateGuestOs", - "params": [ { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "UUID of the Guest OS", - "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs,updateGuestOs", - "required": true, - "type": "uuid" + "description": "the list of nics associated with the shared filesystem", + "name": "nic", + "response": [ + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the 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 vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "whether this guest OS is available for end users", - "length": 255, - "name": "forDisplay", - "required": false, - "type": "boolean" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "Unique display name for Guest OS", - "length": 255, - "name": "osdisplayname", - "required": true, + "description": "name of the shared filesystem", + "name": "name", "type": "string" - } - ], - "related": "listOsTypes,addGuestOs", - "response": [ + }, { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" }, { - "description": "the name of the OS type", - "name": "name", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the ID of the OS type", + "description": "ID of the shared filesystem", "name": "id", "type": "string" }, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the name/description of the OS type", - "name": "description", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" } ], - "since": "4.4.0" + "since": "4.20.0" }, { - "description": "Lists all guest vlans", - "isasync": false, - "name": "listGuestVlans", + "description": "Updates an existing IPv4 subnet for a zone.", + "isasync": true, + "name": "updateIpv4SubnetForZone", "params": [ { - "description": "limits search results to allocated guest vlan. false by default.", + "description": "The new CIDR of the IPv4 subnet.", "length": 255, - "name": "allocatedonly", - "required": false, - "type": "boolean" + "name": "subnet", + "required": true, + "type": "string" }, { - "description": "list guest vlan by vnet", + "description": "Id of the guest network IPv4 subnet", "length": 255, - "name": "vnet", - "required": false, + "name": "id", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,updateIpv4SubnetForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "required": true, + "type": "uuid" + } + ], + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "response": [ + { + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { - "description": "list guest vlan by id", - "length": 255, - "name": "id", - "required": false, - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list guest vlan by zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { - "description": "list guest vlan by physical network", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "", + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + {}, + {}, + { + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", + "type": "string" + }, + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Destroys a system virtual machine.", + "isasync": true, + "name": "destroySystemVm", + "params": [ + { + "description": "The ID of the system virtual machine", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "id", + "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "the zone ID of the guest VLAN range", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "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 physical network name of the guest VLAN range", - "name": "physicalnetworkname", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "the guest VLAN", - "name": "vlan", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the project id of the guest VLAN range", - "name": "projectid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the zone name of the guest VLAN range", - "name": "zonename", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the physical network ID of the guest VLAN range", - "name": "physicalnetworkid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the guest VLAN id", - "name": "id", - "type": "long" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, + { + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, {}, { - "description": "the project name of the guest VLAN range", - "name": "project", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the list of networks who use this guest VLAN", - "name": "network", - "type": "list" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, + {}, { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "true if the guest VLAN is dedicated to the account", - "name": "isdedicated", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "date the guest VLAN was taken", - "name": "taken", + "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 date and time the system VM was created", + "name": "created", "type": "date" }, - {} - ], - "since": "4.17.0" - }, - { - "description": "Updates resource limits for an account or domain.", - "isasync": false, - "name": "updateResourceLimit", - "params": [ { - "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": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "Update resource for a specified account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, { - "description": " Maximum resource limit.", - "length": 255, - "name": "max", - "required": false, - "type": "long" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "Update resource limits for project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "listResourceLimits", - "response": [ + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" + }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" + }, + { + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" + }, + { + "description": "the state of the system VM", + "name": "state", "type": "string" }, { @@ -6460,214 +6283,218 @@ "type": "integer" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" - }, - { - "description": "the account of the resource limit", - "name": "account", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "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 public IP address for the system VM", + "name": "publicip", "type": "string" }, - {}, - {}, { - "description": "the project id of the resource limit", - "name": "projectid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ] - }, - { - "description": "Deletes a static route", - "isasync": true, - "name": "deleteStaticRoute", - "params": [ - { - "description": "the ID of the static route", - "length": 255, - "name": "id", - "related": "createStaticRoute,listStaticRoutes", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {} + { + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" + }, + { + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" + } ] }, { - "description": "Lists hosts metrics", + "description": "Archive one or more events.", "isasync": false, - "name": "listHostsMetrics", + "name": "archiveEvents", "params": [ { - "description": "if true, list only hosts dedicated to HA", + "description": "start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "hahost", + "name": "startdate", "required": false, - "type": "boolean" + "type": "date" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "archive by event type", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the IDs of the events", "length": 255, - "name": "pagesize", + "name": "ids", + "related": "listEvents", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the name of the host", + "description": "end date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "name", + "name": "enddate", "required": false, + "type": "date" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "lists hosts existing in particular cluster", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "List Autonomous Systems Numbers", + "isasync": false, + "name": "listASNumbers", + "params": [ + { + "description": "the zone ID", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the state of the host", + "description": "the AS Number range ID", "length": 255, - "name": "state", + "name": "asnrangeid", + "related": "createASNRange,listASNRanges", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "", "length": 255, - "name": "outofbandmanagementenabled", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the Pod ID for the host", + "description": "domain id", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, { - "description": "the host type", + "description": "AS number", "length": 255, - "name": "type", + "name": "asnumber", + "related": "listASNumbers", "required": false, - "type": "string" + "type": "integer" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "", "length": 255, - "name": "details", + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "account name", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "account", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "the vpc id", "length": 255, - "name": "keyword", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the id of the host", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]", + "description": "to indicate if the AS number is allocated to any network", "length": 255, - "name": "resourcestate", + "name": "isallocated", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the Zone ID for the host", + "description": "the network id", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" } @@ -6675,505 +6502,630 @@ "related": "", "response": [ { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "Allocation state", + "name": "allocationstate", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "Created Date", + "name": "created", + "type": "date" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "AS Number", + "name": "asnumber", + "type": "long" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "Domain ID", + "name": "domainid", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the zone name of the AS Number range", + "name": "zonename", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "Allocated Date", + "name": "allocated", + "type": "date" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "Zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "instances on the host", - "name": "instances", + "description": "VPC ID", + "name": "vpcid", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "Network Name", + "name": "associatednetworkname", + "type": "string" }, + {}, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VPC Name", + "name": "vpcname", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the domain name", + "name": "domain", + "type": "string" }, { - "description": "the average cpu load the last minute", - "name": "cpuloadaverage", - "type": "double" + "description": "AS Number ID", + "name": "asnrangeid", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "Network ID", + "name": "associatednetworkid", + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the account name", + "name": "account", "type": "string" }, + {}, { - "description": "out-of-band management power state", - "name": "powerstate", - "type": "powerstate" + "description": "ID of the AS Number", + "name": "id", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "Account ID", + "name": "accountid", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "Deletes a secondary staging store .", + "isasync": false, + "name": "deleteSecondaryStagingStore", + "params": [ { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", + "description": "the staging store ID", + "length": 255, + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "the current status 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 hypervisor version", - "name": "hypervisorversion", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "List registered userdatas", + "isasync": false, + "name": "listUserData", + "params": [ + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "network read in GiB", - "name": "networkread", - "type": "string" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", + "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 host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the ID of the Userdata", + "length": 255, + "name": "id", + "related": "listUserData", + "required": false, + "type": "uuid" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "Userdata name to look for", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotalgb", + "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 domain name of the userdata owner", + "name": "domain", "type": "string" }, - {}, { - "description": "the name of the host", + "description": "Name of the userdata", "name": "name", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the owner of the userdata", + "name": "account", + "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "the project id of the userdata", + "name": "projectid", + "type": "string" }, + {}, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "path of the domain to which the userdata owner belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the project name of the userdata", + "name": "project", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "params", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the owner id of the userdata", + "name": "accountid", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "network write in GiB", - "name": "networkwrite", + "description": "the domain id of the userdata owner", + "name": "domainid", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "base64 encoded userdata content", + "name": "userdata", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" + } + ], + "since": "4.18" + }, + { + "description": "Updates an internal load balancer", + "isasync": true, + "name": "updateLoadBalancer", + "params": [ + { + "description": "the ID of the load balancer", + "length": 255, + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "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 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 host type", - "name": "type", - "type": "type" - }, - { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", + "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 amount of the host's memory currently used", - "name": "memoryused", - "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, + "since": "4.4", + "type": "string" + } + ], + "related": "createLoadBalancer,listLoadBalancers", + "response": [ + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "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 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the account of the Load Balancer", + "name": "account", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, + {}, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the Load Balancer ID", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the instance ID", + "name": "id", + "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 name of the instance", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + }, + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + } + ], + "type": "list" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, + {}, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "Load Balancer source ip", + "name": "sourceipaddress", "type": "string" - }, + } + ], + "since": "4.4.0" + }, + { + "description": "Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.", + "isasync": true, + "name": "scaleSystemVm", + "params": [ { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "The ID of the system vm", + "length": 255, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, + "type": "uuid" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "the service offering ID to apply to the system vm", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + } + ], + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", + "response": [ + { + "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 version", - "name": "version", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the Pod ID for the system VM", + "name": "podid", + "type": "string" }, {}, { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "system vm instances on the host", - "name": "systeminstances", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, + {}, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - } - ], - "since": "4.9.3" - }, - { - "description": "get load balancer certificate", - "isasync": false, - "name": "getLoadBalancerSslCertificate", - "params": [ - { - "description": "the ID of Lb", - "length": 255, - "name": "id", - "related": "getLoadBalancerSslCertificate", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "crt", - "name": "crt", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, - {}, - {}, { - "description": "chain", - "name": "chain", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { @@ -7182,357 +7134,209 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "key", - "name": "key", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" - } - ] - }, - { - "description": "Release the dedication for the pod", - "isasync": true, - "name": "releaseDedicatedPod", - "params": [ - { - "description": "the ID of the Pod", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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": "Lists affinity groups", - "isasync": false, - "name": "listAffinityGroups", - "params": [ - { - "description": "lists affinity groups by type", - "length": 255, - "name": "type", - "required": false, + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "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": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "list the affinity group by the ID provided", - "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", - "required": false, - "type": "uuid" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the template name for the system VM", + "name": "templatename", + "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,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "lists affinity groups by name", - "length": 255, - "name": "name", - "required": false, + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" - } - ], - "related": "createAffinityGroup", - "response": [ + }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, - {}, { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", + "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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" - } - ] - }, - { - "description": "Cancels a triggered shutdown", - "isasync": false, - "name": "cancelShutdown", - "params": [ - { - "description": "the uuid of the management server", - "length": 255, - "name": "managementserverid", - "related": "listManagementServers", - "required": true, - "type": "uuid" - } - ], - "related": "prepareForShutdown,readyForShutdown,triggerShutdown", - "response": [ - { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, - {}, - {}, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" } - ], - "since": "4.19.0" + ] }, { - "description": "Register a public key in a keypair under a certain name", + "description": "Verify the OAuth Code and fetch the corresponding user from provider", "isasync": false, - "name": "registerSSHKeyPair", + "name": "verifyOAuthCodeAndGetUser", "params": [ { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional project for the ssh key", + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "secretcode", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Public key material of the keypair", - "length": 5120, - "name": "publickey", - "required": true, - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "", "length": 255, - "name": "account", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Name of the keypair", + "description": "Name of the provider", "length": 255, - "name": "name", + "name": "provider", "required": true, "type": "string" } ], - "related": "listSSHKeyPairs", + "related": "updateOauthProvider", "response": [ { - "description": "Name of the keypair", - "name": "name", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain id of the keypair owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" - }, - { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, - {}, { - "description": "ID of the ssh keypair", + "description": "ID of the provider", "name": "id", "type": "string" }, + {}, { - "description": "the owner of the keypair", - "name": "account", - "type": "string" - }, - { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "Name of the provider", + "name": "provider", "type": "string" }, { @@ -7541,194 +7345,124 @@ "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "Name of the provider", + "name": "name", "type": "string" - } - ] - }, - { - "description": "Destroys a l2tp/ipsec remote access vpn", - "isasync": true, - "name": "deleteRemoteAccessVpn", - "params": [ - { - "description": "public ip address id of the vpn server", - "length": 255, - "name": "publicipid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "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": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Description of the provider registered", + "name": "description", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" } - ] + ], + "since": "4.19.0" }, { - "description": "Start rolling maintenance", - "isasync": true, - "name": "startRollingMaintenance", + "description": "List DRS plans for a clusters", + "isasync": false, + "name": "listClusterDrsPlan", "params": [ { - "description": "optional operation timeout (in seconds) that overrides the global timeout setting", + "description": "", "length": 255, - "name": "timeout", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the IDs of the pods to start maintenance on", - "length": 255, - "name": "podids", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "list" - }, - { - "description": "the IDs of the hosts to start maintenance on", + "description": "List by keyword", "length": 255, - "name": "hostids", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "the IDs of the clusters to start maintenance on", + "description": "ID of the cluster", "length": 255, - "name": "clusterids", + "name": "clusterid", "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "list" - }, - { - "description": "the command to execute while hosts are on maintenance", - "length": 255, - "name": "payload", - "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the IDs of the zones to start maintenance on", + "description": "ID of the drs plan", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "if rolling mechanism should continue in case of an error", + "description": "", "length": 255, - "name": "forced", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" } ], - "related": "", + "related": "generateClusterDrsPlan,executeClusterDrsPlan", "response": [ { - "description": "the hosts skipped", - "name": "hostsskipped", - "response": [ - { - "description": "the name of the skipped host", - "name": "hostname", - "type": "string" - }, - { - "description": "the reason to skip the host", - "name": "reason", - "type": "string" - }, - { - "description": "the ID of the skipped host", - "name": "hostid", - "type": "string" - } - ], - "type": "list" + "description": "Id of the cluster", + "name": "clusterid", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "unique ID of the drs plan for cluster", + "name": "id", + "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": "the name of the updated host", - "name": "hostname", - "type": "string" - }, - { - "description": "output of the maintenance script on the host", - "name": "output", - "type": "string" - }, - { - "description": "the ID of the updated host", - "name": "hostid", - "type": "string" - }, - { - "description": "end date of the update on the host", - "name": "enddate", - "type": "string" - }, - { - "description": "start date of the update on the host", - "name": "startdate", - "type": "string" - } - ], - "type": "list" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, + {}, { - "description": "in case of failure, details are displayed", - "name": "details", - "type": "string" + "description": "List of migrations", + "name": "migrations", + "type": "list" }, - {}, - {}, { - "description": "indicates if the rolling maintenance operation was successful", - "name": "success", - "type": "boolean" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" } - ] + ], + "since": "4.19.0" }, { - "description": "list Tungsten-Fabric application policy set", + "description": "Lists clusters.", "isasync": false, - "name": "listTungstenFabricApplicationPolicySet", + "name": "listClusters", "params": [ { "description": "", @@ -7738,1763 +7472,2131 @@ "type": "integer" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "lists clusters by cluster type", "length": 255, - "name": "applicationpolicysetuuid", + "name": "clustertype", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "keyword", + "name": "managedstate", "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "lists clusters by Zone ID", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" - } - ], - "related": "createTungstenFabricApplicationPolicySet", - "response": [ - {}, - { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "lists clusters by allocation state", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, - {}, - { - "description": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" - }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "lists clusters by the cluster name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" - }, - { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", - "type": "string" - } - ] - }, - { - "description": "Updates network ACL list", - "isasync": true, - "name": "updateNetworkACLList", - "params": [ - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "customid", + "name": "id", + "related": "addCluster,listClusters,updateCluster", "required": false, - "since": "4.4", - "type": "string" + "type": "uuid" }, { - "description": "an optional field, whether to the display the list to the end user or not", + "description": "", "length": 255, - "name": "fordisplay", + "name": "page", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "Name of the network ACL list", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "name", + "name": "hypervisor", "required": false, "type": "string" }, { - "description": "Description of the network ACL list", + "description": "List by keyword", "length": 255, - "name": "description", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of the network ACL", + "description": "lists clusters by Pod ID", "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": true, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, "type": "uuid" + }, + { + "description": "flag to display the capacity of the clusters", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" } ], + "related": "addCluster,updateCluster", "response": [ - {}, - {}, + { + "description": "the type of the cluster", + "name": "clustertype", + "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", + "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": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" - } - ], - "since": "4.4" - }, - { - "description": "Reserve a public IP to an account.", - "isasync": false, - "name": "reserveIpAddress", - "params": [ - { - "description": "the ID of the public IP address to reserve", - "length": 255, - "name": "id", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" }, { - "description": "the ID of the project to reserve with this IP address", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" }, { - "description": "the ID of the domain to reserve with this IP address", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "type": "boolean" + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" }, { - "description": "the account to reserve with this IP address", - "length": 255, - "name": "account", - "required": false, + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" - } - ], - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "response": [ + }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" }, {}, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", + "description": "the capacity of the Cluster", + "name": "capacity", "response": [ { - "description": "tag key name", - "name": "key", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the Cluster name", + "name": "clustername", "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" } ], "type": "list" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", + "description": "the Zone name of the cluster", "name": "zonename", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "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": "the account the public IP address is associated with", - "name": "account", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, + {} + ] + }, + { + "description": "Lists project invitations and provides detailed information for listed invitations", + "isasync": false, + "name": "listProjectInvitations", + "params": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "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": "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": "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": "VPC id the ip belongs to", - "name": "vpcid", + "description": "list invitations by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "list invitations by id", + "length": 255, + "name": "id", + "related": "listProjectInvitations", + "required": false, + "type": "uuid" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "is public IP portable across the zones", - "name": "isportable", + "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 zone the public IP address belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "public IP address", - "name": "ipaddress", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list by project id", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" - }, + } + ], + "related": "", + "response": [ {}, { - "description": "public IP address id", + "description": "the id of the invitation", "name": "id", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the User ID", + "name": "userid", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the id of the project", + "name": "projectid", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the name of the project", + "name": "project", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the email the invitation was sent to", + "name": "email", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "path of the Domain the project belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, + {}, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the invitation state", + "name": "state", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the account name of the project's owner", + "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" } ], - "since": "4.17" + "since": "3.0.0" }, { - "description": "Restore a VM to original template/ISO or new template/ISO", - "isasync": true, - "name": "restoreVirtualMachine", + "description": "Lists all egress firewall rules for network ID.", + "isasync": false, + "name": "listEgressFirewallRules", "params": [ { - "description": "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "Virtual Machine ID", + "description": "", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Lists rule with the specified ID.", + "length": 255, + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": false, "type": "uuid" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the network ID for the egress firewall services", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + } + ], + "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the account associated with the tag", + "name": "account", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", + "type": "string" + }, + { + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + {}, + { + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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 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 network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + {} + ] + }, + { + "description": "Lists clusters metrics", + "isasync": false, + "name": "listClustersMetrics", + "params": [ + { + "description": "lists clusters by allocation state", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "lists clusters by Zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "lists clusters by cluster type", + "length": 255, + "name": "clustertype", + "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 Pod ID", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "lists clusters by the cluster name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "flag to display the capacity of the clusters", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" + }, + { + "description": "whether this cluster is managed by cloudstack", + "length": 255, + "name": "managedstate", + "required": false, + "type": "string" + }, + { + "description": "lists clusters by hypervisor type", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "state of the cluster", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, + { + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", + "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": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the total cpu used in Ghz", + "name": "cpuused", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", + "type": "string" + }, + { + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" + }, + { + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "the capacity of the Cluster", + "name": "capacity", + "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the Zone ID", + "name": "zoneid", "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" } ], - "type": "set" + "type": "list" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", + "type": "string" + }, + { + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" + }, + {}, + { + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" + }, + { + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total cpu capacity in GiB", + "name": "memorytotal", + "type": "string" + }, + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "the cluster ID", + "name": "id", + "type": "string" + }, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, + { + "description": "running / total hosts in the cluster", + "name": "hosts", + "type": "string" + }, + { + "description": "DRS imbalance for the cluster", + "name": "drsimbalance", + "type": "string" + }, + { + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" + }, + { + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" + } + ], + "since": "4.9.3" + }, + { + "description": "Lists objects at specified path on a storage pool.", + "isasync": false, + "name": "listStoragePoolObjects", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "id of the storage pool", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + }, + { + "description": "path to list on storage pool", + "length": 255, + "name": "path", + "required": false, "type": "string" + } + ], + "related": "listImageStoreObjects", + "response": [ + { + "description": "Size is in Bytes.", + "name": "size", + "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Template ID associated with the data store object.", + "name": "templateid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", + "type": "string" }, - {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Volume Name associated with the data store object.", + "name": "volumename", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Template Name associated with the data store object.", + "name": "templatename", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, - { - "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 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": "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "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": "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the 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 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" + }, + { + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "Volume ID associated with the data store object.", + "name": "volumeid", "type": "string" }, {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "Name of the data store object.", + "name": "name", + "type": "string" + }, + {}, + { + "description": "Format of template associated with the data store object.", + "name": "format", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Lists secondary staging stores.", + "isasync": false, + "name": "listSecondaryStagingStores", + "params": [ + { + "description": "the ID of the staging store", + "length": 255, + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "required": false, + "type": "uuid" + }, + { + "description": "the staging store protocol", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + }, + { + "description": "the staging store provider", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the Zone ID for the staging store", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the staging store", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "response": [ + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the ID of the image store", + "name": "id", + "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 Zone name of the image store", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the project id of the vm", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, + {}, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the 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" + } + ], + "since": "4.2.0" + }, + { + "description": "Starts a router.", + "isasync": true, + "name": "startRouter", + "params": [ + { + "description": "the ID of the router", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,startRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ + { + "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "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 second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, + {}, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the 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 isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" - } - ], - "type": "set" - }, - { - "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 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 affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ + }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" } ], "type": "set" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "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": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + } + ], + "type": "list" }, + {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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 Zone name for the router", + "name": "zonename", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the name of the host for the virtual machine", + "description": "the hostname for the router", "name": "hostname", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "the date and time the router was created", + "name": "created", "type": "date" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" - }, + } + ] + }, + { + "description": "Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings", + "isasync": false, + "name": "resetConfiguration", + "params": [ { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the ID of the Account to reset the parameter value for corresponding account", + "length": 255, + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the ID of the Zone to reset the parameter value for corresponding zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the configuration", + "length": 255, + "name": "name", + "required": true, "type": "string" }, - {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the ID of the Domain to reset the parameter value for corresponding domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the Image Store to reset the parameter value for corresponding image store", + "length": 255, + "name": "imagestoreid", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "required": false, + "type": "uuid" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, + "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + } + ], + "related": "listConfigurations,updateConfiguration", + "response": [ { - "description": "the state of the virtual machine", - "name": "state", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", + "type": "string" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Delete one or more events.", - "isasync": false, - "name": "deleteEvents", - "params": [ + }, { - "description": "delete by event type", - "length": 255, - "name": "type", - "required": false, + "description": "the description of the configuration", + "name": "description", "type": "string" }, { - "description": "the IDs of the events", - "length": 255, - "name": "ids", - "related": "listEvents", - "required": false, - "type": "list" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "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 component of the configuration", + "name": "component", + "type": "string" }, + {}, { - "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - } - ], - "response": [ + "description": "the group of the configuration", + "name": "group", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the possible options of the configuration value", + "name": "options", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the category of the configuration", + "name": "category", "type": "string" }, - {}, + { + "description": "the value of the configuration", + "name": "id", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} - ] - }, - { - "description": " delete a nicira nvp device", - "isasync": true, - "name": "deleteNiciraNvpDevice", - "params": [ - { - "description": "Nicira device ID", - "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", - "required": true, - "type": "uuid" - } - ], - "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", + "description": "the display text of the configuration", "name": "displaytext", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the parent configuration", + "name": "parent", + "type": "string" } - ] + ], + "since": "4.16.0" }, { - "description": "List ucs blades", - "isasync": false, - "name": "listUcsBlades", + "description": "Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group.", + "isasync": true, + "name": "createAutoScalePolicy", "params": [ { - "description": "", + "description": "the name of the autoscale policy", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "string" }, { - "description": "", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "page", + "name": "quiettime", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "conditionids", + "related": "createCondition,listConditions", + "required": true, + "type": "list" }, { - "description": "ucs manager id", + "description": "the duration in which the conditions have to be true before action is taken", "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", + "name": "duration", "required": true, - "type": "uuid" + "type": "integer" + }, + { + "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" } ], - "related": "associateUcsProfileToBlade", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" + }, + { + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { - "description": "ucs manager id", - "name": "ucsmanagerid", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, { - "description": "ucs blade dn", - "name": "bladedn", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id autoscale policy", + "name": "projectid", + "type": "string" + }, + { + "description": "name of the autoscale policy", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the autoscale policy", + "name": "project", + "type": "string" + }, + { + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", + "type": "string" }, { - "description": "ucs blade id", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "associated ucs profile dn", - "name": "profiledn", + "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 cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", + "type": "integer" } ] }, { - "description": "Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user", - "isasync": true, - "name": "notifyBaremetalProvisionDone", + "description": "Removes stratosphere ssp server", + "isasync": false, + "name": "deleteStratosphereSsp", "params": [ { - "description": "mac of the nic used for provision", + "description": "the host ID of ssp server", "length": 255, - "name": "mac", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, - "type": "object" + "type": "uuid" } ], "response": [ - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {} + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { - "description": "Get Volume Snapshot Details", + "description": "Lists Usage Server metrics", "isasync": false, - "name": "getVolumeSnapshotDetails", - "params": [ - { - "description": "CloudStack Snapshot UUID", - "length": 255, - "name": "snapshotid", - "required": true, - "type": "string" - } - ], - "related": "getVolumeiScsiName", + "name": "listUsageServerMetrics", + "params": [], + "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, + {}, { - "description": "Volume iSCSI Name", - "name": "volumeiScsiName", + "description": "the name of the active usage server", + "name": "hostname", "type": "string" }, + { + "description": "the last time a usage job successfully completed", + "name": "lastsuccessfuljob", + "type": "date" + }, {}, - {}, + { + "description": "the last time this Usage Server checked for jobs", + "name": "lastheartbeat", + "type": "date" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the usage server", + "name": "state", + "type": "state" } - ] + ], + "since": "4.17.0" }, { - "description": "Deletes an ISO file.", + "description": "Enables HA for a zone", "isasync": true, - "name": "deleteIso", + "name": "enableHAForZone", "params": [ { - "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,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "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", + "description": "ID of the zone", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", - "required": false, + "required": true, "type": "uuid" } ], @@ -9510,228 +9612,303 @@ "type": "boolean" }, {}, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" } - ] + ], + "since": "4.11" }, { - "description": "Updates a host.", - "isasync": false, - "name": "updateHost", - "params": [ + "description": "Cleanups VM reservations in the database.", + "isasync": true, + "name": "cleanVMReservations", + "params": [], + "response": [ { - "description": "list of tags to be added to the host", - "length": 255, - "name": "hosttags", - "required": false, - "type": "list" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the ID of the host to update", - "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", - "required": true, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the id of Os category to update the host with", - "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": false, - "type": "uuid" - }, - { - "description": "Change the name of host", - "length": 255, - "name": "name", - "required": false, - "since": "4.15", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ] + }, + { + "description": "Updates Routing firewall rule with specified ID", + "isasync": true, + "name": "updateRoutingFirewallRule", + "params": [ { - "description": "the new uri for the secondary storage: nfs://host/path", + "description": "an optional field, whether to the display the Routing firewall rule to the end user or not", "length": 255, - "name": "url", + "name": "fordisplay", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "istagarule", + "name": "customid", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" }, { - "description": "Add an annotation to this host", + "description": "the ID of the Routing firewall rule", "length": 255, - "name": "annotation", - "required": false, - "since": "4.11", - "type": "string" + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "response": [ + {}, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, - {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "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 starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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 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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the state of the rule", + "name": "state", + "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 host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "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 starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, - {}, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } + ], + "since": "4.20.0" + }, + { + "description": "Lists object storage pools.", + "isasync": false, + "name": "listObjectStoragePools", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the name of the object store", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the object store provider", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the storage pool", + "length": 255, + "name": "id", + "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", + "required": false, + "type": "uuid" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "addObjectStoragePool,updateObjectStoragePool", + "response": [ { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the provider name of the object store", + "name": "providername", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the url of the object store", + "name": "url", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" - }, - { - "description": "the amount of the host's CPU currently allocated 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", @@ -9739,114 +9916,130 @@ "type": "boolean" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the object store currently used size", + "name": "storageused", + "type": "long" }, { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the ID of the object store", + "name": "id", + "type": "string" }, { - "description": "the name of the host", + "description": "the name of the object store", "name": "name", "type": "string" }, + {}, + {}, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "create secondary staging store.", + "isasync": false, + "name": "createSecondaryStagingStore", + "params": [ { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the URL for the staging store", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the scope of the staging store: zone only for now", + "length": 255, + "name": "scope", + "required": false, + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the staging store provider name", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the Zone ID for the staging store", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, + "description": "the details for the staging store", + "length": 255, + "name": "details", + "required": false, + "type": "map" + } + ], + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "response": [ { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "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 date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the host version", - "name": "version", + "description": "the url of the image store", + "name": "url", "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 after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, + {}, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, + {}, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { - "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": "the UUID of the latest async job acting on this object", @@ -9854,314 +10047,234 @@ "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "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" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" - }, + } + ] + }, + { + "description": "Remove a VMware datacenter from a zone.", + "isasync": false, + "name": "removeVmwareDc", + "params": [ { - "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 id of Zone from which VMware datacenter has to be removed.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the host", - "name": "id", + "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ] }, { - "description": "Creates a egress firewall rule for a given network ", + "description": "Updates load balancer health check policy", "isasync": true, - "name": "createEgressFirewallRule", + "name": "updateLBHealthCheckPolicy", "params": [ { - "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "ID of load balancer health check policy", "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "name": "id", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", + "required": true, + "type": "uuid" }, { - "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "destcidrlist", + "name": "customid", "required": false, - "type": "list" + "since": "4.4", + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "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": "error code for this icmp message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" - }, + } + ], + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", + "response": [ { - "description": "the ending port of firewall rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" }, { - "description": "type of the icmp message being sent", - "length": 255, - "name": "icmptype", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the network id of the port forwarding rule", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - }, - { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", - "length": 255, - "name": "protocol", - "required": true, + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, { - "description": "type of firewallrule: system/user", - "length": 255, - "name": "type", - "required": false, + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the starting port of firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" - } - ], - "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule", - "response": [ - { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "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 firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "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 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 ID of the firewall rule", - "name": "id", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of healthcheckpolicies", + "name": "healthcheckpolicy", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the description of the healthcheck policy", + "name": "description", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the LB HealthCheck policy ID", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" } ], "type": "list" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.4" + }, + { + "description": "remove Tungsten-Fabric policy", + "isasync": true, + "name": "removeTungstenFabricPolicyRule", + "params": [ + { + "description": "the Uuid of Tungsten-Fabric policy rule", + "length": 255, + "name": "ruleuuid", + "required": true, "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the Uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" + } + ], + "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", + "response": [ + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", @@ -10169,1053 +10282,916 @@ "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" } ] }, { - "description": "Lists VPC offerings", - "isasync": false, - "name": "listVPCOfferings", + "description": "Creates a load balancer rule", + "isasync": true, + "name": "createLoadBalancerRule", "params": [ { - "description": "id of zone VPC offering is associated with", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "algorithm", + "required": true, + "type": "string" + }, + { + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, - "since": "4.13", - "type": "uuid" + "type": "string" }, { - "description": "list VPC offerings by name", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.", "length": 255, - "name": "name", + "name": "cidrlist", + "required": false, + "since": "4.18.0.0", + "type": "list" + }, + { + "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", + "length": 255, + "name": "protocol", "required": false, "type": "string" }, { - "description": "", + "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": "page", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list VPC offerings available for VPC creation in specific domain", + "description": "the domain ID associated with the load balancer", "length": 255, "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "since": "4.18", "type": "uuid" }, { - "description": "", + "description": "the public port from where the network traffic will be load balanced from", "length": 255, - "name": "pagesize", - "required": false, + "name": "publicport", + "required": true, "type": "integer" }, { - "description": "list VPC offerings by display text", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "displaytext", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "true if need to list only default VPC offerings. Default value is false", + "description": "the account associated with the load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "isdefault", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list VPC offerings supporting certain services", + "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "name": "privateport", + "required": true, + "type": "integer" }, { - "description": "list VPC offerings by id", + "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "public IP address ID from where the network traffic will be load balanced from", "length": 255, - "name": "keyword", + "name": "publicipid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, + "type": "uuid" + }, + { + "description": "name of the load balancer rule", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "list VPC offerings by state", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", "length": 255, - "name": "state", + "name": "openfirewall", "required": false, - "type": "string" + "type": "boolean" } ], - "related": "updateVPCOffering", + "related": "listLoadBalancerRules,updateLoadBalancerRule", "response": [ { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" - }, - { - "description": "the list of supported services", - "name": "service", + "description": "the list of resource tags associated with load balancer", + "name": "tags", "response": [ { - "description": "the service name", - "name": "name", + "description": "the project name where tag belongs to", + "name": "project", "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": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" + "description": "tag key name", + "name": "key", + "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "list" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "the id of the vpc offering", - "name": "id", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, + {}, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" }, - {}, { - "description": "the name of the vpc offering", - "name": "name", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" - } - ] - }, - { - "description": "Get the SF volume size including Hypervisor Snapshot Reserve", - "isasync": false, - "name": "getSolidFireVolumeSize", - "params": [ - { - "description": "Volume UUID", - "length": 255, - "name": "volumeid", - "required": true, + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" - } - ], - "related": "", - "response": [ + }, {}, { - "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": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", - "name": "solidFireVolumeSize", - "type": "long" + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Uploads a data disk.", - "isasync": true, - "name": "uploadVolume", - "params": [ { - "description": "the ID of the zone the volume is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the description of the load balancer", + "name": "description", + "type": "string" }, { - "description": "Upload volume for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the public ip address", + "name": "publicip", + "type": "string" }, { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, + "description": "the account of the load balancer rule", "name": "account", - "required": false, "type": "string" }, { - "description": "the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the volume", - "length": 255, - "name": "name", - "required": true, + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" + "description": "the public ip address id", + "name": "publicipid", + "type": "string" }, { - "description": "Image store uuid", + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + } + ] + }, + { + "description": "Import vSphere storage policies", + "isasync": false, + "name": "importVsphereStoragePolicies", + "params": [ + { + "description": "ID of the zone", "length": 255, - "name": "imagestoreuuid", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "related": "listVsphereStoragePolicies", "response": [ { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the name of the Storage Policy", + "name": "name", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, + {}, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the description of the Storage Policy", + "name": "description", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Disables out-of-band management for a zone", + "isasync": true, + "name": "disableOutOfBandManagementForZone", + "params": [ { - "description": "name of the availability zone", - "name": "zonename", + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", + "response": [ + { + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, + {}, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the out-of-band management action (if issued)", + "name": "action", "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { - "description": "the path of the volume", - "name": "path", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Stops a system VM.", + "isasync": true, + "name": "stopSystemVm", + "params": [ + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "The ID of the system virtual machine", + "length": 255, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", + "required": true, + "type": "uuid" + } + ], + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "response": [ + { + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, + {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "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 disk volume", - "name": "state", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the state of the system VM", + "name": "state", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" }, + {}, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "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": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the list of resource tags associated", - "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "set" + "description": "the name of the system VM", + "name": "name", + "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the Pod ID for the system VM", + "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": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" - }, + } + ] + }, + { + "description": "Deletes an egress firewall rule", + "isasync": true, + "name": "deleteEgressFirewallRule", + "params": [ { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, + "description": "the ID of the firewall rule", + "length": 255, + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - } + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} ] }, { - "description": "Lists security groups", - "isasync": false, - "name": "listSecurityGroups", + "description": "Updates a VPC", + "isasync": true, + "name": "updateVPC", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "an optional field, whether to the display the vpc to the end user or not", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list the security group by the id provided", + "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": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", - "required": false, - "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "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 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,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the display text of the VPC", "length": 255, - "name": "account", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "pagesize", + "name": "publicmtu", "required": false, + "since": "4.18.0", "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": "lists security groups by name", + "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", "length": 255, - "name": "securitygroupname", + "name": "sourcenatipaddress", "required": false, + "since": "4.19", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the id of the VPC", "length": 255, - "name": "tags", - "required": false, - "type": "map" + "name": "id", + "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the VPC", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], - "related": "createSecurityGroup,updateSecurityGroup", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "description": "the project id of the group", - "name": "projectid", - "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 project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of supported services", + "name": "service", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the provider name", + "name": "name", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], - "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" + "type": "list" } ], - "type": "set" + "type": "list" }, { - "description": "the list of resource tags associated with the rule", + "description": "the id of the VPC", + "name": "id", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" + }, + {}, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the project", "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", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -11224,8 +11200,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -11234,8 +11210,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -11244,279 +11220,218 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the 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": "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": "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 account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ] - }, - { - "description": "Configures a host's out-of-band management interface", - "isasync": false, - "name": "configureOutOfBandManagement", - "params": [ + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + }, { - "description": "the host management interface port", - "length": 255, - "name": "port", - "required": true, + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the host management interface driver, for example: ipmitool", - "length": 255, - "name": "driver", - "required": true, + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "the host management interface password", - "length": 255, - "name": "password", - "required": true, + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, + {}, { - "description": "the host management interface IP address", - "length": 255, - "name": "address", - "required": true, + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the host management interface user", - "length": 255, - "name": "username", - "required": true, + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,disableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", - "response": [ + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", + "type": "string" + }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", + "description": "is vpc for display to the regular user", + "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, + { + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the owner of the VPC", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the VPC", + "name": "project", "type": "string" } - ], - "since": "4.9.0" + ] }, { - "description": "List OAuth providers registered", + "description": "Lists all IPv6 firewall rules", "isasync": false, - "name": "listOauthProvider", + "name": "listIpv6FirewallRules", "params": [ { - "description": "Name of the provider", + "description": "", "length": 255, - "name": "provider", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the OAuth provider", + "description": "", "length": 255, - "name": "id", - "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "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": "fordisplay", + "required": false, + "type": "boolean" }, { "description": "List by keyword", @@ -11526,163 +11441,210 @@ "type": "string" }, { - "description": "", + "description": "Lists ipv6 firewall rule with the specified ID", "length": 255, - "name": "page", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" - } - ], - "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", - "response": [ - {}, + "type": "boolean" + }, { - "description": "Name of the provider", - "name": "name", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "Name of the provider", - "name": "provider", + "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "Description of the provider registered", - "name": "description", + "description": "list ipv6 firewall rules by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + } + ], + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "response": [ + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "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 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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the 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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "ID of the provider", - "name": "id", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, - {} - ], - "since": "4.19.0" - }, - { - "description": "Lists storage tags", - "isasync": false, - "name": "listStorageTags", - "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the pool ID of the storage tag", - "name": "poolid", - "type": "long" }, { - "description": "the name of the storage tag", - "name": "name", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, {}, { - "description": "the ID of the storage tag", - "name": "id", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Delete Service Package", - "isasync": false, - "name": "deleteServicePackageOffering", - "params": [ - { - "description": "the service offering ID", - "length": 255, - "name": "id", - "related": "registerNetscalerServicePackage,listRegisteredServicePackages", - "required": true, + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "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", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -11690,717 +11652,1005 @@ "name": "jobstatus", "type": "integer" }, - {}, - {} + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + } ] }, { - "description": "Delete VM Schedule.", + "description": "List VM Schedules.", "isasync": false, - "name": "deleteVMSchedule", + "name": "listVMSchedule", "params": [ { - "description": "ID of VM schedule", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "ID of VM", + "description": "ID of the VM for which schedule is to be defined", "length": 255, "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, { - "description": "IDs of VM schedule", + "description": "Action taken by schedule", "length": 255, - "name": "ids", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "name": "action", "required": false, - "type": "list" - } - ], - "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of VM schedule", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {} - ], - "since": "4.19.0" - }, - { - "description": "List template visibility and all accounts that have permissions to view this template.", - "isasync": false, - "name": "listTemplatePermissions", - "params": [ { - "description": "the template ID", + "description": "ID of VM schedule", "length": 255, "name": "id", - "related": "listIsoPermissions,listTemplatePermissions,listTemplatePermissions,listIsoPermissions", - "required": true, + "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "required": false, "type": "uuid" } ], - "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", + "related": "createVMSchedule,updateVMSchedule", "response": [ - {}, + { + "description": "Action", + "name": "action", + "type": "action" + }, {}, { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the template ID", + "description": "the ID of VM schedule", "name": "id", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "VM schedule is enabled", + "name": "enabled", "type": "boolean" }, { - "description": "the list of projects the template is available for", - "name": "projectids", - "type": "list" + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Cron formatted VM schedule", + "name": "schedule", "type": "string" }, + { + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" + }, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "Description of VM schedule", + "name": "description", + "type": "string" + }, + {}, + { + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + { + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" } - ] + ], + "since": "4.19.0" }, { - "description": "Destroys a system virtual machine.", + "description": "Attempts to live patch systemVMs - CPVM, SSVM ", "isasync": true, - "name": "destroySystemVm", + "name": "patchSystemVm", "params": [ { - "description": "The ID of the system virtual machine", + "description": "patches systemVM - CPVM/SSVM with the specified ID", "length": 255, "name": "id", - "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", - "required": true, + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": false, "type": "uuid" + }, + { + "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "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.17.0" + }, + { + "description": "Lists volume metrics", + "isasync": false, + "name": "listVolumesMetrics", + "params": [ { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "list only volumes that are encrypted", + "length": 255, + "name": "isencrypted", + "required": false, + "since": "4.19.1", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of disk volume", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" - }, + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "type": "uuid" + }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "listsystemvms", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "list volumes on specified host", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" + "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.19.1", + "type": "uuid" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the cluster id the disk volume belongs to", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "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 private netmask for the system VM", - "name": "privatenetmask", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "the ID of the storage pool, available to ROOT admin only", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.3", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the name of the disk volume", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "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 pod id the disk volume belongs to", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "list volumes by disk offering", + "length": 255, + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the IDs of the volumes, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "since": "4.9", "type": "list" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + } + ], + "related": "", + "response": [ + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "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": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "disk size in GiB", + "name": "sizegb", "type": "string" }, - {}, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "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": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "size of the disk volume", + "name": "size", + "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 network domain for the system VM", - "name": "networkdomain", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, + {}, { - "description": "the Zone name for the system VM", - "name": "zonename", + "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": "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, + {}, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "name of the disk volume", + "name": "name", "type": "string" }, - {}, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ] - }, - { - "description": "Lists annotations.", - "isasync": false, - "name": "listAnnotations", - "params": [ + }, { - "description": "optional: the id of the user of the annotation", - "length": 255, - "name": "userid", - "required": false, - "since": "4.16.0", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "the id of the annotation", - "length": 255, - "name": "id", - "required": false, + "description": "the path of the volume", + "name": "path", "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", - "required": false, - "since": "4.16.0", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the entity type", - "length": 255, - "name": "entitytype", - "required": false, + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the id of the entity for which to show annotations", - "length": 255, - "name": "entityid", - "required": false, + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" - } - ], - "related": "addAnnotation,removeAnnotation,updateAnnotationVisibility", - "response": [ + }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, - {}, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, - {}, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" - } - ], - "since": "4.11" - }, - { - "description": "Adds Swift.", - "isasync": false, - "name": "addSwift", - "params": [ + }, { - "description": "the account for swift", - "length": 255, - "name": "account", - "required": false, + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": " key for the user for swift", - "length": 255, - "name": "key", - "required": false, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the URL for swift", - "length": 255, - "name": "url", - "required": true, + "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 username for swift", - "length": 255, - "name": "username", - "required": false, + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" - } - ], - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", - "response": [ + }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "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": "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": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the ID of the image store", - "name": "id", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, - {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the state of the disk volume", + "name": "state", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + } + ], + "since": "4.9.3" + }, + { + "description": "Lists all possible details and their options for a resource type such as a VM or a template", + "isasync": false, + "name": "listDetailOptions", + "params": [ + { + "description": "the UUID of the resource (optional)", + "length": 255, + "name": "resourceid", + "required": false, "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the resource type such as UserVm, Template etc.", + "length": 255, + "name": "resourcetype", + "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 name of the image store", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "Map of all possible details and their possible list of values", + "name": "details", + "type": "map" } ], - "since": "3.0.0" + "since": "4.13" }, { - "description": "Archive one or more events.", + "description": "Lists SSL certificates", "isasync": false, - "name": "archiveEvents", + "name": "listSslCerts", "params": [ { - "description": "end date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "ID of SSL certificate", "length": 255, - "name": "enddate", + "name": "certid", + "related": "uploadSslCert,listSslCerts", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "archive by event type", + "description": "Load balancer rule ID", "length": 255, - "name": "type", + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "start date range to archive events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "Project that owns the SSL certificate", "length": 255, - "name": "startdate", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "the IDs of the events", + "description": "Account ID", "length": 255, - "name": "ids", - "related": "listEvents", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "list" + "type": "uuid" } ], + "related": "uploadSslCert", "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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", + "description": "certificate chain", + "name": "certchain", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "SSL certificate ID", + "name": "id", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {} - ] - }, - { - "description": "Deletes a secondary staging store .", - "isasync": false, - "name": "deleteSecondaryStagingStore", - "params": [ { - "description": "the staging store ID", - "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the project id of the certificate", + "name": "projectid", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" + }, + { + "description": "name", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the certificate", + "name": "project", + "type": "string" + }, + { + "description": "certificate", + "name": "certificate", "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "account for the certificate", + "name": "account", + "type": "string" + }, + { + "description": "certificate fingerprint", + "name": "fingerprint", + "type": "string" } - ], - "since": "4.2.0" + ] }, { - "description": "List registered userdatas", + "description": "List private gateways", "isasync": false, - "name": "listUserData", + "name": "listPrivateGateways", "params": [ { - "description": "the ID of the Userdata", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "id", - "related": "listUserData", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "list gateways by vpc", "length": 255, - "name": "page", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -12408,10 +12658,24 @@ "description": "list only resources belonging to the domain specified", "length": 255, "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, + { + "description": "list gateways by ip address", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "list gateways by state", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -12421,11 +12685,12 @@ "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list private gateway by id", "length": 255, - "name": "listall", + "name": "id", + "related": "createPrivateGateway,listPrivateGateways,createPrivateGateway,listPrivateGateways", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -12435,16 +12700,23 @@ "type": "boolean" }, { - "description": "Userdata name to look for", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list gateways by vlan", + "length": 255, + "name": "vlan", "required": false, "type": "string" }, @@ -12456,407 +12728,791 @@ "type": "string" } ], - "related": "", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "response": [ { - "description": "the domain name of the userdata owner", - "name": "domain", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "description": "the owner id of the userdata", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the private gateway's netmask", + "name": "netmask", + "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "params", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, { - "description": "the owner of the userdata", - "name": "account", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "base64 encoded userdata content", - "name": "userdata", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "Name of the userdata", - "name": "name", + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, { - "description": "the domain id of the userdata owner", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the private gateway", "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "zone id of the private gateway", + "name": "zoneid", + "type": "string" + }, + { + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", + "type": "string" }, {}, - {} - ], - "since": "4.18" - }, - { - "description": "Updates an internal load balancer", - "isasync": true, - "name": "updateLoadBalancer", - "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "the id of the private gateway", + "name": "id", "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", + "description": "the domain associated with the private gateway", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "path of the domain to which the private gateway belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "Source Nat enable status", + "name": "sourcenatsupported", "type": "boolean" }, { - "description": "the ID of the load balancer", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the account associated with the private gateway", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the private gateway", + "name": "projectid", + "type": "string" + }, + { + "description": "the private gateway's ip address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + } + ] + }, + { + "description": "Update the default Ip of a VM Nic", + "isasync": true, + "name": "updateVmNicIp", + "params": [ + { + "description": "the ID of the nic to which you want to assign private IP", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "nicid", + "related": "listNics", "required": true, "type": "uuid" + }, + { + "description": "Secondary IP Address", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" } ], - "related": "createLoadBalancer,listLoadBalancers", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ { - "description": "the name of the Load Balancer", - "name": "name", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "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": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the ip address of the instance", - "name": "ipaddress", - "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "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": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "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 instance ID", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", "name": "id", "type": "string" }, { - "description": "the name of the instance", - "name": "name", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the state of the instance", - "name": "state", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ + }, { - "description": "the state of the load balancer rule", - "name": "state", + "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": "instance port of the load balancer rule", - "name": "instanceport", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "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": "list" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the domain of the Load Balancer", - "name": "domain", - "type": "string" + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, - {}, - {}, - { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - }, - { - "description": "Load Balancer source ip", - "name": "sourceipaddress", - "type": "string" - }, - { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" - }, - { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" - }, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" - } - ], - "since": "4.4.0" - }, - { - "description": "Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.", - "isasync": true, - "name": "scaleSystemVm", - "params": [ - { - "description": "the service offering ID to apply to the system vm", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "The ID of the system vm", - "length": 255, + "description": "the ID of the virtual machine", "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", - "required": true, - "type": "uuid" - }, - { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", - "length": 255, - "name": "details", - "required": false, - "type": "map" - } - ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", - "response": [ - { - "description": "the link local IP address for the system vm", - "name": "linklocalip", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - {}, - {}, - { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { @@ -12865,2352 +13521,2121 @@ "type": "integer" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the pool type of the virtual machine", + "name": "pooltype", "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 IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - } - ] - }, - { - "description": "Lists snapshot policies.", - "isasync": false, - "name": "listSnapshotPolicies", - "params": [ - { - "description": "the ID of the snapshot policy", - "length": 255, - "name": "id", - "related": "createSnapshotPolicy,updateSnapshotPolicy,listSnapshotPolicies", - "required": false, - "type": "uuid" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": false, - "type": "uuid" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "createSnapshotPolicy,updateSnapshotPolicy", - "response": [ - { - "description": "the ID of the snapshot policy", - "name": "id", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - {}, - { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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 project id the tag belongs to", - "name": "projectid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "Type of adapter if available", + "name": "adaptertype", + "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 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 vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" } ], "type": "set" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, + {}, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ] - }, - { - "description": "Update site to site vpn customer gateway", - "isasync": true, - "name": "updateVpnCustomerGateway", - "params": [ + "description": "OS name of the vm", + "name": "osdisplayname", + "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" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "ESP policy of the customer gateway", - "length": 255, - "name": "esppolicy", - "required": true, + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "Force encapsulation for Nat Traversal", - "length": 255, - "name": "forceencap", - "required": false, + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", - "length": 255, - "name": "ikeversion", - "required": false, - "since": "4.15.1", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", - "length": 255, - "name": "ipsecpsk", - "required": true, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "length": 255, - "name": "ikepolicy", - "required": true, + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": true, + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "name of this customer gateway", - "length": 255, - "name": "name", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "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", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", - "required": true, - "type": "uuid" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "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 name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "length": 255, - "name": "gateway", - "required": true, + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" - } - ], - "related": "createVpnCustomerGateway,listVpnCustomerGateways", - "response": [ + }, { - "description": "the project name", - "name": "project", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, - {}, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, - {}, { - "description": "the owner", - "name": "account", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" - }, + } + ] + }, + { + "description": "Starts an existing internal lb vm.", + "isasync": true, + "name": "startInternalLoadBalancerVM", + "params": [ { - "description": "the project id", - "name": "projectid", + "description": "the ID of the internal lb vm", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ + { + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "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 list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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 broadcast uri of the nic", + "name": "broadcasturi", + "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 netmask of the nic", + "name": "netmask", + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the name of the router", + "name": "name", "type": "string" - } - ] - }, - { - "description": "Verify the OAuth Code and fetch the corresponding user from provider", - "isasync": false, - "name": "verifyOAuthCodeAndGetUser", - "params": [ + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", - "length": 255, - "name": "secretcode", - "required": false, - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "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": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + } + ], + "type": "list" }, { - "description": "Name of the provider", - "length": 255, - "name": "provider", - "required": true, + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "updateOauthProvider", - "response": [ + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Name of the provider", - "name": "provider", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, - {}, { - "description": "Description of the provider registered", - "name": "description", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "ID of the provider", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "Name of the provider", - "name": "name", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, - {}, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "description": "the Pod name for the router", + "name": "podname", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "apply Tungsten-Fabric tag", - "isasync": true, - "name": "applyTungstenFabricTag", - "params": [ - { - "description": "the uuid of networks", - "length": 255, - "name": "networkuuid", - "required": false, - "type": "list" }, { - "description": "the uuid of vms", - "length": 255, - "name": "vmuuid", - "required": false, - "type": "list" - }, - { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": false, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the account associated with the router", + "name": "account", + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag", - "length": 255, - "name": "taguuid", - "required": true, + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the uuid of nics", - "length": 255, - "name": "nicuuid", - "required": false, - "type": "list" + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": false, + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" - } - ], - "related": "createTungstenFabricTag,removeTungstenFabricTag", - "response": [ - {}, + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, - {}, { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" + "description": "the host ID for the router", + "name": "hostid", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" - } - ] - }, - { - "description": "Updates object storage pool", - "isasync": false, - "name": "updateObjectStoragePool", - "params": [ + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, { - "description": "Object Store ID", - "length": 255, - "name": "id", - "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", - "required": true, - "type": "uuid" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the name for the object store", - "length": 255, - "name": "name", - "required": false, + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the url for the object store", - "length": 255, - "name": "url", - "required": false, + "description": "role of the domain router", + "name": "role", "type": "string" - } - ], - "related": "addObjectStoragePool,listObjectStoragePools", - "response": [ + }, + {}, { - "description": "the provider name of the object store", - "name": "providername", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the ID of the object store", - "name": "id", + "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 Zone name for the router", + "name": "zonename", + "type": "string" }, { - "description": "the total size of the object store", - "name": "storagetotal", - "type": "long" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" }, { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "the name of the object store", - "name": "name", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the version of template", + "name": "version", + "type": "string" }, - {}, - {}, { - "description": "the url of the object store", - "name": "url", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" } - ], - "since": "4.19.0" + ] }, { - "description": "List DRS plans for a clusters", + "description": "Updates a disk offering.", "isasync": false, - "name": "listClusterDrsPlan", + "name": "updateDiskOffering", "params": [ { - "description": "ID of the drs plan", + "description": "length (in seconds) of the burst", "length": 255, - "name": "id", - "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", + "name": "iopsreadratemaxlength", "required": false, - "type": "uuid" + "since": "4.15", + "type": "long" }, { - "description": "ID of the cluster", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", + "name": "byteswriteratemax", "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "length (in seconds) of the burst", "length": 255, - "name": "keyword", + "name": "bytesreadratemaxlength", "required": false, - "type": "string" + "since": "4.15", + "type": "long" }, { - "description": "", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "page", + "name": "displayoffering", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, - "name": "pagesize", + "name": "zoneid", "required": false, - "type": "integer" - } - ], - "related": "generateClusterDrsPlan,executeClusterDrsPlan", - "response": [ - {}, - { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "since": "4.13", + "type": "string" }, - {}, - {}, { - "description": "unique ID of the drs plan for cluster", - "name": "id", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, + "since": "4.13", "type": "string" }, { - "description": "Start event Id of the DRS Plan", - "name": "eventid", + "description": "updates alternate display text of the disk offering with this value", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "burst io requests write rate of the disk offering", + "length": 255, + "name": "iopswriteratemax", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "Id of the cluster", - "name": "clusterid", + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "length": 255, + "name": "tags", + "required": false, + "since": "4.15", "type": "string" }, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "sort key of the disk offering, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" }, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" - } - ], - "since": "4.19.0" - }, - { - "description": "This deprecated function used to locks an account. Look for the API DisableAccount instead", - "isasync": false, - "name": "lockAccount", - "params": [ + "description": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", + "required": false, + "since": "4.15", + "type": "long" + }, { - "description": "Locks the specified account on this domain.", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, - "type": "uuid" + "name": "byteswriterate", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "Locks the specified account.", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "account", - "required": true, - "type": "string" - } - ], - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "response": [ + "name": "iopswriterate", + "required": false, + "since": "4.15", + "type": "long" + }, { - "description": "the name of the account", - "name": "name", + "description": "the cache mode to use for this disk offering", + "length": 255, + "name": "cachemode", + "required": false, + "since": "4.15", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "updates name of the disk offering with this value", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "state of the disk offering", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" - }, + "description": "length (in seconds) of the burst", + "length": 255, + "name": "byteswriteratemaxlength", + "required": false, + "since": "4.15", + "type": "long" + } + ], + "related": "createDiskOffering,listDiskOfferings", + "response": [ { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "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 total number of networks owned by account", - "name": "networktotal", + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "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 total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "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 total number of public ip addresses allocated for this account", - "name": "iptotal", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the network domain", - "name": "networkdomain", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "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 tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", "type": "integer" }, - { - "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": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, + {}, {}, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "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 total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "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 list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", - "type": "string" + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", + "type": "boolean" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "state of the disk offering", + "name": "state", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "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 user state", - "name": "state", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "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": "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", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - } - ], - "type": "list" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" - }, - { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the state of the account", - "name": "state", - "type": "string" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" } ] }, { - "description": "Stops a router.", - "isasync": true, - "name": "stopRouter", + "description": "Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", + "isasync": false, + "name": "removeVirtualMachinesFromKubernetesCluster", "params": [ { - "description": "the ID of the router", + "description": "the ID of the Kubernetes cluster", "length": 255, "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,startRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": true, "type": "uuid" }, { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "description": "", "length": 255, - "name": "forced", + "name": "page", "required": false, - "type": "boolean" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,startRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" + "type": "integer" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "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" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - } - ], + "description": "the IDs of the VMs to remove from the cluster", + "length": 255, + "name": "virtualmachineids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, "type": "list" - }, + } + ], + "related": "", + "response": [ { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the id of the Kubernetes cluster", + "name": "id", "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 template ID for the router", - "name": "templateid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {}, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.19.0" + }, + { + "description": "delete Tungsten-Fabric logical router", + "isasync": true, + "name": "deleteTungstenFabricLogicalRouter", + "params": [ { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the uuid of Tungsten-Fabric logical router", + "length": 255, + "name": "logicalrouteruuid", + "required": true, "type": "string" - }, + } + ], + "response": [ { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "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 gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - } - ], - "type": "set" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Reset site to site vpn connection", + "isasync": true, + "name": "resetVpnConnection", + "params": [ + { + "description": "an optional account for connection. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "id of vpn connection", + "length": 255, + "name": "id", + "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", + "required": true, + "type": "uuid" }, { - "description": "the domain ID associated with the router", + "description": "an optional domainId for connection. If the account parameter is used, domainId must also be used.", + "length": 255, "name": "domainid", - "type": "string" - }, + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + } + ], + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "response": [ { - "description": "the version of template", - "name": "version", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" }, { - "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", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, + {}, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "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": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the public IP address", + "name": "publicip", "type": "string" }, + {}, { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, - {}, { - "description": "the account associated with the router", + "description": "the owner", "name": "account", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "the id of the router", + "description": "the connection ID", "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" } ] }, { - "description": "Lists clusters.", + "description": "Lists Kubernetes clusters", "isasync": false, - "name": "listClusters", + "name": "listKubernetesClusters", "params": [ { - "description": "lists clusters by hypervisor type", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "hypervisor", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "lists clusters by Pod ID", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "flag to display the capacity of the clusters", + "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": "showcapacities", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "state of the Kubernetes cluster", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "List by keyword", "length": 255, - "name": "managedstate", + "name": "keyword", "required": false, "type": "string" }, { - "description": "lists clusters by allocation state", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "allocationstate", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists clusters by the cluster ID", + "description": "the ID of the Kubernetes cluster", "length": 255, "name": "id", - "related": "addCluster,listClusters,updateCluster", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "lists clusters by the cluster name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "lists clusters by cluster type", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "clustertype", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists clusters by Zone ID", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "clustertype", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "string" } ], - "related": "addCluster,updateCluster", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, - {}, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the cluster ID", - "name": "id", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the cluster name", - "name": "name", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the capacity of the Cluster", - "name": "capacity", - "response": [ - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "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 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 Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - } - ], - "type": "list" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, - {}, + { + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" + }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - } - ] - }, - { - "description": "Deletes project invitation", - "isasync": true, - "name": "deleteProjectInvitation", - "params": [ + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, { - "description": "id of the invitation", - "length": 255, - "name": "id", - "related": "listProjectInvitations", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, + { + "description": "keypair details", + "name": "keypair", + "type": "string" + }, + { + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" + }, {}, - {}, + { + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" + }, + { + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" + }, + { + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" + }, + { + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists project invitations and provides detailed information for listed invitations", - "isasync": false, - "name": "listProjectInvitations", - "params": [ + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the state of the Kubernetes cluster", + "name": "state", + "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" + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" }, { - "description": "list by project id", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" + } + ] + }, + { + "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", + "isasync": true, + "name": "createAutoScaleVmGroup", + "params": [ + { + "description": "the ID of the load balancer rule", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, "type": "uuid" }, { - "description": "", + "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": "page", - "required": false, + "name": "maxmembers", + "required": true, "type": "integer" }, { - "description": "list invitation by user ID", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "list invitations by id", + "description": "the autoscale profile that contains information about the vms in the vm group.", "length": 255, - "name": "id", - "related": "listProjectInvitations", - "required": false, + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the 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": "isrecursive", - "required": false, - "type": "boolean" + "name": "minmembers", + "required": true, + "type": "integer" }, { - "description": "list invitations by state", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "state", + "name": "name", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list of scaleup autoscale policies", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the frequency in which the performance counters to be collected", "length": 255, - "name": "listall", + "name": "interval", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" } ], - "related": "", + "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the account name of the project's owner", - "name": "account", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the project", - "name": "project", + "description": "the public ip address", + "name": "publicip", "type": "string" }, - {}, { - "description": "the email the invitation was sent to", - "name": "email", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, - {}, { - "description": "the id of the invitation", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + { + "description": "the autoscale vm group ID", "name": "id", "type": "string" }, { - "description": "the User ID", - "name": "userid", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" + }, + { + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account owning the vm group", + "name": "account", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + }, + { + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the invitation state", + "description": "the current state of the AutoScale Vm Group", "name": "state", "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "create Tungsten-Fabric firewall policy", - "isasync": true, - "name": "createTungstenFabricFirewallPolicy", - "params": [ + }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "Tungsten-Fabric firewall policy name", - "length": 255, - "name": "name", - "required": true, + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": false, + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the sequence of Tungsten-Fabric firewall policy", - "length": 255, - "name": "sequence", - "required": true, - "type": "integer" - } - ], - "related": "listTungstenFabricFirewallPolicy", - "response": [ + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "Tungsten-Fabric firewall policy uuid", - "name": "uuid", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, + { + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" + }, + {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public port", + "name": "publicport", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -15218,342 +15643,272 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" } ] }, { - "description": "Lists all egress firewall rules for network ID.", - "isasync": false, - "name": "listEgressFirewallRules", + "description": "Change the BGP peers for a VPC.", + "isasync": true, + "name": "changeBgpPeersForVpc", "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 objects by project; if projectid=-1 lists All VMs", + "description": "Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "Lists rule with the specified ID.", + "description": "UUID of the VPC which the Bgp Peers are associated to.", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", - "required": false, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, + } + ], + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "response": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "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": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project name of the bgp peer", + "name": "project", "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": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "id of the bgp peer", + "name": "id", + "type": "string" }, { - "description": "the network ID for the egress firewall services", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - } - ], - "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", - "response": [ + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" + }, {}, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" }, + {}, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "list" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the account of the bgp peer", + "name": "account", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "add a baremetal ping pxe server", + "isasync": true, + "name": "addBaremetalPxePingServer", + "params": [ { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" + "description": "Pod Id", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "type of pxe device", + "length": 255, + "name": "pxeservertype", + "required": true, "type": "string" }, - {}, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "Root directory on PING storage server", + "length": 255, + "name": "pingdir", + "required": true, "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "PING storage server ip", + "length": 255, + "name": "pingstorageserverip", + "required": true, "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "description": "Tftp root directory of PXE server", + "length": 255, + "name": "tftpdir", + "required": true, + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Updates a region", - "isasync": false, - "name": "updateRegion", - "params": [ - { - "description": "updates region with this name", + "description": "Username of PING storage server", "length": 255, - "name": "name", + "name": "pingcifsusername", "required": false, "type": "string" }, { - "description": "updates region with this end point", + "description": "URL of the external pxe device", "length": 255, - "name": "endpoint", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "Id of region to update", + "description": "the Physical Network ID", "length": 255, - "name": "id", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "integer" + "type": "uuid" + }, + { + "description": "Password of PING storage server", + "length": 255, + "name": "pingcifspassword", + "required": false, + "type": "string" } ], - "related": "addRegion,listRegions", + "related": "", "response": [ + {}, { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "PING storage server ip", + "name": "pingstorageserverip", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device id of ", + "name": "id", + "type": "string" }, - {}, { - "description": "the ID of the region", - "name": "id", - "type": "integer" + "description": "Tftp root directory of PXE server", + "name": "tftpdir", + "type": "string" }, { - "description": "the name of the region", - "name": "name", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "Root directory on PING storage server", + "name": "pingdir", "type": "string" }, {}, { - "description": "the end point of the region", - "name": "endpoint", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" + "description": "url", + "name": "url", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Deletes traffic type of a physical network", + "description": "Deletes a load balancer rule.", "isasync": true, - "name": "deleteTrafficType", + "name": "deleteLoadBalancerRule", "params": [ { - "description": "traffic type id", + "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "addTrafficType,updateTrafficType", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": true, "type": "uuid" } @@ -15572,493 +15927,402 @@ }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists clusters metrics", + "description": "list portable IP ranges", "isasync": false, - "name": "listClustersMetrics", + "name": "listPortableIpRanges", "params": [ - { - "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": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "lists clusters by Zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "lists clusters by the cluster ID", + "description": "Id of the portable ip range", "length": 255, "name": "id", - "related": "addCluster,updateCluster", + "related": "createPortableIpRange,listPortableIpRanges", "required": false, "type": "uuid" }, { - "description": "lists clusters by allocation state", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, - { - "description": "lists clusters by the cluster name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "lists clusters by cluster type", - "length": 255, - "name": "clustertype", - "required": false, - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", + "description": "List by keyword", "length": 255, - "name": "managedstate", + "name": "keyword", "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", + "description": "Id of a Region", "length": 255, - "name": "hypervisor", + "name": "regionid", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], - "related": "", + "related": "createPortableIpRange", "response": [ { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "portable IP range ID", + "name": "id", "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the capacity of the Cluster", - "name": "capacity", + "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", + "name": "portableipaddress", "response": [ { - "description": "the capacity name", - "name": "name", + "description": "VPC the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "the account ID the portable IP address is associated with", + "name": "accountid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the Zone ID", + "description": "the ID of the zone the public IP address belongs to", "name": "zoneid", "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": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", "type": "string" } ], "type": "list" }, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the end ip of the portable IP range", + "name": "endip", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" }, + {}, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Returns user data associated with the VM", + "isasync": false, + "name": "getVirtualMachineUserData", + "params": [ { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", - "type": "string" - }, + "description": "The ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + {}, { - "description": "the cluster name", - "name": "name", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, { - "description": "running / total hosts in the cluster", - "name": "hosts", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cluster ID", - "name": "id", + "description": "the ID of the virtual machine", + "name": "virtualmachineid", "type": "string" - }, - {}, + } + ], + "since": "4.4" + }, + { + "description": "Updates network permissions.", + "isasync": false, + "name": "createNetworkPermissions", + "params": [ { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", - "type": "string" + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accountids", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accounts", + "required": false, + "type": "list" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "list" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.17.0" + }, + { + "description": "Disables static rule for given IP address", + "isasync": true, + "name": "disableStaticNat", + "params": [ { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" - }, + "description": "the public IP address ID for which static NAT feature is being disabled", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" - }, - { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" - }, - { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the total cpu used in GiB", - "name": "memoryused", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", - "type": "string" - }, - { - "description": "state of the cluster", - "name": "state", - "type": "string" - }, - { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", - "type": "boolean" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "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" } - ], - "since": "4.9.3" + ] }, { - "description": "Lists objects at specified path on a storage pool.", - "isasync": false, - "name": "listStoragePoolObjects", + "description": "Assigns secondary IP to NIC", + "isasync": true, + "name": "addIpToNic", "params": [ { - "description": "List by keyword", + "description": "the ID of the nic to which you want to assign private IP", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "nicid", + "related": "listNics", + "required": true, + "type": "uuid" }, { - "description": "path to list on storage pool", + "description": "Secondary IP Address", "length": 255, - "name": "path", + "name": "ipaddress", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "id of the storage pool", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" } ], - "related": "listImageStoreObjects", + "related": "", "response": [ + {}, { - "description": "Is it a directory.", - "name": "isdirectory", - "type": "boolean" - }, - { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", - "type": "string" - }, - { - "description": "Template ID associated with the data store object.", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "Format of template associated with the data store object.", - "name": "format", + "description": "the ID of the nic", + "name": "nicid", "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": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "the list of Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", + "description": "Secondary IP address", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the network", + "name": "networkid", + "type": "string" }, { - "description": "Name of the data store object.", - "name": "name", + "description": "the ID of the vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" + "description": "the ID of the secondary private IP addr", + "name": "id", + "type": "string" } - ], - "since": "4.19.0" + ] }, { - "description": "Lists a project's project role permissions", + "description": "Delete a Ucs manager", "isasync": false, - "name": "listProjectRolePermissions", + "name": "deleteUcsManager", "params": [ { - "description": "ID of the project", + "description": "ucs manager id", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", "required": true, "type": "uuid" - }, - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" } ], - "related": "createProjectRolePermission", "response": [ + {}, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { @@ -16067,814 +16331,580 @@ "type": "integer" }, { - "description": "the description of the role permission", - "name": "description", - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the project role permission", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the project", - "name": "projectid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } - ], - "since": "4.15.0" + ] }, { - "description": "Lists all LDAP configurations", + "description": "Deletes a host.", "isasync": false, - "name": "listLdapConfigurations", + "name": "deleteHost", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": false, - "type": "string" - }, - { - "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", + "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": "listall", + "name": "forced", "required": false, - "since": "4.13.2", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "linked domain", + "description": "the host ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, "type": "uuid" }, { - "description": "Port", + "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", "length": 255, - "name": "port", + "name": "forcedestroylocalstorage", "required": false, - "type": "integer" + "type": "boolean" } ], - "related": "addLdapConfiguration,deleteLdapConfiguration", "response": [ - {}, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "linked domain", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the host running the ldap server", - "name": "hostname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" } - ], - "since": "4.2.0" + ] }, { - "description": "Lists secondary staging stores.", + "description": "deletes the resource icon from the specified resource(s)", "isasync": false, - "name": "listSecondaryStagingStores", + "name": "deleteResourceIcon", "params": [ { - "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": "the Zone ID for the staging store", + "description": "type of the resource", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "name": "resourcetype", + "required": true, + "type": "string" }, { - "description": "", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, + "name": "resourceids", + "required": true, + "type": "list" + } + ], + "response": [ { - "description": "the staging store provider", - "length": 255, - "name": "provider", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the name of the staging store", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the staging store protocol", - "length": 255, - "name": "protocol", - "required": false, - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "since": "4.16.0.0" + }, + { + "description": "Lists capabilities", + "isasync": false, + "name": "listCapabilities", + "params": [], + "related": "", "response": [ { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "Display name for custom hypervisor", + "name": "customhypervisordisplayname", "type": "string" }, {}, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", + "type": "integer" }, { - "description": "the url of the image store", - "name": "url", - "type": "string" + "description": "the retention time for Instances disks stats", + "name": "instancesdisksstatsretentiontime", + "type": "integer" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the min Ram size for the service offering used by the shared filesystem instance", + "name": "sharedfsvmminramsize", + "type": "integer" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "default page size in the UI for various views, value set in the configurations", + "name": "defaultuipagesize", "type": "long" }, + {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", "type": "long" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" - }, - { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "true if users are allowed to force stop a vm, false otherwise", + "name": "allowuserforcestopvm", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the min CPU count for the service offering used by the shared filesystem instance", + "name": "sharedfsvmmincpucount", "type": "integer" }, - {}, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Creates a l2tp/ipsec remote access vpn", - "isasync": true, - "name": "createRemoteAccessVpn", - "params": [ - { - "description": "an optional account for the VPN. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "the retention time for Instances stats", + "name": "instancesstatsretentiontime", + "type": "integer" }, { - "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": "maximum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingmaxsize", + "type": "long" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true if users can see all accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", "type": "boolean" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", - "length": 255, - "name": "openfirewall", - "required": false, + "description": "true if stats are collected only for user instances, false if system instance stats are also collected", + "name": "instancesstatsuseronly", "type": "boolean" }, { - "description": "public ip address id of the vpn server", - "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", + "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, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ], - "related": "listRemoteAccessVpns,updateRemoteAccessVpn", - "response": [ - { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "true if regular user is allowed to create projects", + "name": "allowusercreateprojects", + "type": "boolean" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", + "type": "boolean" }, { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", + "type": "boolean" }, { - "description": "the id of the remote access vpn", - "name": "id", - "type": "string" + "description": "true if the user can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", + "type": "boolean" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", - "type": "string" + "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", - "type": "integer" + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", + "type": "boolean" }, - {}, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "true if region supports elastic load balancer on basic zones", + "name": "supportELB", "type": "string" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", + "type": "boolean" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "time interval (in seconds) to reset api count", + "name": "apilimitinterval", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "version of the cloud stack", + "name": "cloudstackversion", "type": "string" }, - {}, { - "description": "the public ip address of the vpn server", - "name": "publicip", - "type": "string" + "description": "true if user and domain admins can set templates to be shared, false otherwise", + "name": "userpublictemplateenabled", + "type": "boolean" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", - "type": "string" + "description": "true if stats are retained for instance disks otherwise false", + "name": "instancesdisksstatsretentionenabled", + "type": "boolean" + }, + { + "description": "true if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", + "type": "boolean" } ] }, { - "description": "Starts a router.", + "description": "Release dedication of zone", "isasync": true, - "name": "startRouter", + "name": "releaseDedicatedZone", "params": [ { - "description": "the ID of the router", + "description": "the ID of the Zone", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,startRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" } ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the version of template", - "name": "version", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - }, - { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - } - ], - "type": "list" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {} + ] + }, + { + "description": "Updates a network serviceProvider of a physical network", + "isasync": true, + "name": "updateNetworkServiceProvider", + "params": [ { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "network service provider id", + "length": 255, + "name": "id", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "required": true, + "type": "uuid" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "the list of services to be enabled for this physical network service provider", + "length": 255, + "name": "servicelist", + "required": false, + "type": "list" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "Enabled/Disabled/Shutdown the physical network service provider", + "length": 255, + "name": "state", + "required": false, "type": "string" - }, + } + ], + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the state of the router", + "description": "state of the network provider", "name": "state", - "type": "state" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "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 state of redundant virtual router", - "name": "redundantstate", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "since": "3.0.0" + }, + { + "description": "Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only", + "isasync": true, + "name": "checkVolume", + "params": [ { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "The ID of the volume", + "length": 255, + "name": "id", + "related": "attachVolume,checkVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "parameter to repair the volume, leaks or all are the possible values", + "length": 255, + "name": "repair", + "required": false, "type": "string" - }, + } + ], + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "response": [ { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the 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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "id of the resource", + "name": "resourceid", "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 project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "tag value", + "name": "value", "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 type of the nic", - "name": "type", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, + {}, { - "description": "the project name of the address", - "name": "project", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -16883,1092 +16913,803 @@ "type": "boolean" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, - {}, { - "description": "the hostname for the router", - "name": "hostname", - "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 guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the state of the disk volume", + "name": "state", "type": "string" - } - ] - }, - { - "description": "(This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect.", - "isasync": false, - "name": "changeServiceForVirtualMachine", - "params": [ + }, { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", - "length": 255, - "name": "automigrate", - "required": false, - "since": "4.17", - "type": "boolean" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "since": "4.17", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVmNicIp,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "New maximum number of IOPS for the custom disk offering", - "length": 255, + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "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": "max iops of the disk volume", "name": "maxiops", - "required": false, - "since": "4.17", "type": "long" }, { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.17", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "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,resetUserDataForVirtualMachine,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,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "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", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", "name": "domain", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the 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", + "description": "the date the disk volume was created", + "name": "created", "type": "date" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "size of the disk volume", + "name": "size", "type": "long" - }, + } + ], + "since": "4.19.1" + }, + { + "description": "Lists Management Server metrics", + "isasync": false, + "name": "listManagementServersMetrics", + "params": [ { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the management server", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "include system level stats", + "length": 255, + "name": "system", + "related": "listManagementServersMetrics", + "required": false, + "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the id of the management server", + "length": 255, + "name": "id", + "related": "listManagementServers", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "The number of blocked threads", + "name": "threadsblockedcount", + "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 project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the 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 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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the 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 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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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" - } - ], - "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 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 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" - }, - { - "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" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "The number of daemon threads", + "name": "threadsdaemoncount", + "type": "integer" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Total system memory", + "name": "systemmemorytotal", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The number of threads", + "name": "threadstotalcount", + "type": "integer" + }, + { + "description": "the system load for user, and system processes and the system idle cycles", + "name": "systemcycleusage", + "type": "long[]" + }, + { + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, + { + "description": "Free system memory", + "name": "systemmemoryfree", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" + }, + { + "description": "the number of client sessions active on this Management Server", + "name": "sessions", + "type": "long" + }, + { + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the system is running against a local database", + "name": "dbislocal", + "type": "boolean" + }, + { + "description": "the IP Address for this Management Server", + "name": "serviceip", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the management server", + "name": "name", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "The number of waiting threads", + "name": "threadswaitingcount", + "type": "integer" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the version of the management server", + "name": "version", + "type": "string" }, + {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "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 project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the 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 number of agents this Management Server is responsible for", + "name": "agentcount", + "type": "integer" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the current cpu load", + "name": "cpuload", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the management server", + "name": "id", + "type": "string" }, - {}, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "Amount of memory used", + "name": "systemmemoryused", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the system has a usage server running locally", + "name": "usageislocal", + "type": "boolean" + }, + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "the log files and their usage on disk", + "name": "loginfo", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the version of the java distribution running the management server process", + "name": "javaversion", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the load averages for 1 5 and 15 minutes", + "name": "systemloadaverages", + "type": "double[]" + }, + { + "description": "the number of processors available to the JVM", + "name": "availableprocessors", + "type": "integer" + }, + { + "description": "The number of runnable threads", + "name": "threadsrunnablecount", + "type": "integer" + }, + { + "description": "The number of terminated threads", + "name": "threadsteminatedcount", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the amount of memory allocated to this Management Server", + "name": "heapmemorytotal", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" + } + ], + "since": "4.17.0" + }, + { + "description": "Removes a virtual machine or a list of virtual machines from a load balancer rule.", + "isasync": true, + "name": "removeFromLoadBalancerRule", + "params": [ + { + "description": "The ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)", + "length": 255, + "name": "virtualmachineids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": false, + "type": "list" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Lists vm groups", + "isasync": false, + "name": "listInstanceGroups", + "params": [ + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the ID of the virtual machine", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list instance groups by ID", + "length": 255, "name": "id", + "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", + "required": false, + "type": "uuid" + }, + { + "description": "list instance groups by name", + "length": 255, + "name": "name", + "required": false, "type": "string" + } + ], + "related": "createInstanceGroup,updateInstanceGroup", + "response": [ + { + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the account owning the instance group", + "name": "account", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, + { + "description": "the project ID of the instance group", + "name": "projectid", "type": "string" }, + {}, { - "description": "the 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 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 IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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 type of the nic", - "name": "type", - "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - } - ], - "type": "set" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the ID of the instance group", + "name": "id", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the domain ID of the instance group", + "name": "domainid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" - }, + } + ] + }, + { + "description": "Creates a static route", + "isasync": true, + "name": "createStaticRoute", + "params": [ { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the gateway id we are creating static route for", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "required": true, + "type": "uuid" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "static route cidr", + "length": 255, + "name": "cidr", + "required": true, "type": "string" - }, + } + ], + "related": "listStaticRoutes", + "response": [ { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the domain associated with the static route", + "name": "domain", "type": "string" }, - {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the ID of static route", + "name": "id", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the account associated with the static route", + "name": "account", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "VPC gateway the route is created for", + "name": "gatewayid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the domain path associated with the static route", + "name": "domainpath", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the project id of the static route", + "name": "projectid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "static route CIDR", + "name": "cidr", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the project name of the static route", + "name": "project", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", + "description": "the ID of the domain associated with the static route", "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -17977,8 +17718,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -17992,178 +17733,219 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the state of the static route", + "name": "state", "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" } ] }, { - "description": "Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings", - "isasync": false, - "name": "resetConfiguration", + "description": "Deletes a Private gateway", + "isasync": true, + "name": "deletePrivateGateway", "params": [ { - "description": "the ID of the Account to reset the parameter value for corresponding account", + "description": "the ID of the private gateway", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, + "name": "id", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "required": true, "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Zone to reset the parameter value for corresponding zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {} + ] + }, + { + "description": "Updates a domain with a new name", + "isasync": false, + "name": "updateDomain", + "params": [ { - "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", + "description": "ID of domain to update", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "required": true, "type": "uuid" }, { - "description": "the ID of the Domain to reset the parameter value for corresponding domain", + "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "networkdomain", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the Image Store to reset the parameter value for corresponding image store", + "description": "updates domain with this name", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", + "name": "name", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "listConfigurations,updateConfiguration", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "response": [ + {}, { - "description": "the type of the configuration value", - "name": "type", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, - {}, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "the group of the configuration", - "name": "group", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + {}, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -18172,386 +17954,388 @@ "type": "integer" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" - } - ], - "since": "4.16.0" - }, - { - "description": "Lists all available OS mappings for given hypervisor", - "isasync": false, - "name": "listGuestOsMapping", - "params": [ + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, { - "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", - "length": 255, - "name": "hypervisorversion", - "required": false, + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "list mapping by its UUID", - "length": 255, - "name": "id", - "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", - "required": false, - "type": "uuid" + "description": "the name of the domain", + "name": "name", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the level of the domain", + "name": "level", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "list Guest OS mapping by OS mapping name with hypervisor", - "length": 255, - "name": "osnameforhypervisor", - "required": false, + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "list Guest OS mapping by hypervisor", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "list mapping by Guest OS Type UUID", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" }, { - "description": "list Guest OS mapping by OS display name", - "length": 255, - "name": "osdisplayname", - "required": false, + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "addGuestOsMapping,updateGuestOsMapping", - "response": [ + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" + }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, - {}, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, - {}, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the ID of the domain", + "name": "id", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the path of the domain", + "name": "path", + "type": "string" } - ], - "since": "4.4.0" + ] }, { - "description": "List all public, private, and privileged templates.", - "isasync": false, - "name": "listTemplates", + "description": "Disables an AutoScale Vm Group", + "isasync": true, + "name": "disableAutoScaleVmGroup", "params": [ { - "description": "the hypervisor for which to restrict the search", + "description": "the ID of the autoscale group", "length": 255, - "name": "hypervisor", - "required": false, + "name": "id", + "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "required": true, + "type": "uuid" + } + ], + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "response": [ + { + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", - "length": 255, - "name": "isvnf", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", - "length": 255, - "name": "details", - "required": false, - "since": "4.15", - "type": "list" + "description": "the public port", + "name": "publicport", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the public ip address id", + "name": "publicipid", + "type": "string" }, { - "description": "show removed templates as well", - "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" }, { - "description": "If set to true, list only unique templates across zones", - "length": 255, - "name": "showunique", - "required": false, - "since": "4.13.2", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the template ID", - "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "uuid" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, + {}, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the current state of the AutoScale Vm Group", + "name": "state", + "type": "string" }, { - "description": "the IDs of the templates, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "since": "4.9", - "type": "list" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "list datadisk templates by parent template id", - "length": 255, - "name": "parenttemplateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "since": "4.4", - "type": "uuid" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "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 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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the domain name of the vm group", + "name": "domain", + "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, + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the type of the template", - "length": 255, - "name": "templatetype", - "required": false, - "since": "4.19.0", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the account owning the vm group", + "name": "account", + "type": "string" }, + {}, { - "description": "ID of the image or image cache store", - "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", - "required": false, - "since": "4.19", - "type": "uuid" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "list templates by zoneId", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the template name", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "flag to display the resource image for the templates", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", + "type": "string" }, { - "description": "ID of the storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.19", - "type": "uuid" - } - ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "the tag of this template", - "name": "templatetag", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" + } + ] + }, + { + "description": "Creates a snapshot policy for the account.", + "isasync": false, + "name": "createSnapshotPolicy", + "params": [ + { + "description": "time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)", + "length": 255, + "name": "schedule", + "required": true, "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "length": 255, + "name": "intervaltype", + "required": true, "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "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": "the date this template was created", - "name": "created", - "type": "date" + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present.", + "length": 255, + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "list" + }, + { + "description": "maximum number of snapshots to retain", + "length": 255, + "name": "maxsnaps", + "required": true, + "type": "integer" + }, + { + "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" + } + ], + "related": "updateSnapshotPolicy,listSnapshotPolicies", + "response": [ + {}, + { + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -18559,8 +18343,8 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -18569,28 +18353,28 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -18599,660 +18383,868 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" }, + {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Disables HA for a zone", + "isasync": true, + "name": "disableHAForZone", + "params": [ + { + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ {}, { - "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": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "the UUID 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 size of the template", - "name": "size", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.11" + }, + { + "description": "Unmanage a volume on storage pool.", + "isasync": true, + "name": "unmanageVolume", + "params": [ + { + "description": "The ID of the volume to unmanage", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "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 template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {} + ], + "since": "4.19.1" + }, + { + "description": "Adds an API permission to a role", + "isasync": false, + "name": "createRolePermission", + "params": [ { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "The description of the role permission", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, + "type": "string" + } + ], + "related": "listRolePermissions", + "response": [ + { + "description": "the name of the role to which the role permission belongs", + "name": "rolename", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, + { + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", + "type": "string" + }, { - "description": "the status of the template", - "name": "status", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the description of the role permission", + "name": "description", + "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 permission type of the api name or wildcard rule, allow/deny", + "name": "permission", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "List system virtual machines.", + "isasync": false, + "name": "listSystemVms", + "params": [ + { + "description": "the name of the system VM", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, - {}, { - "description": "the template ID", - "name": "id", + "description": "the state of the system VM", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the storage ID where vm's volumes belong to", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "3.0.1", + "type": "uuid" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the Pod ID of the system VM", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the host ID of the system VM", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + }, + { + "description": "", + "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": "the ID of the system VM", + "length": 255, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", + "length": 255, + "name": "systemvmtype", + "required": false, + "type": "string" + } + ], + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "response": [ + { + "description": "public vlan range", + "name": "publicvlan", "type": "list" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "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": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the state of the system VM", + "name": "state", "type": "string" - } - ] - }, - { - "description": "Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group.", - "isasync": true, - "name": "createAutoScalePolicy", - "params": [ + }, { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", - "length": 255, - "name": "quiettime", - "required": false, - "type": "integer" + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" }, { - "description": "the name of the autoscale policy", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the duration in which the conditions have to be true before action is taken", - "length": 255, - "name": "duration", - "required": true, + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", "type": "integer" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "length": 255, - "name": "action", - "required": true, + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "length": 255, - "name": "conditionids", - "related": "createCondition,listConditions", - "required": true, - "type": "list" - } - ], - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "response": [ + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" + }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the Pod name for the system VM", + "name": "podname", "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 account owning the autoscale policy", - "name": "account", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "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 project id autoscale policy", - "name": "projectid", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", - "type": "integer" + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "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": "Removes stratosphere ssp server", - "isasync": false, - "name": "deleteStratosphereSsp", - "params": [ + "description": "the systemvm agent version", + "name": "version", + "type": "string" + }, { - "description": "the host ID of ssp server", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "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 Pod ID for the system VM", + "name": "podid", + "type": "string" + }, + { + "description": "the ID of the system VM", + "name": "id", + "type": "string" + }, + { + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" + }, + { + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" } ] }, { - "description": "create Tungsten-Fabric policy", + "description": "Detaches a disk volume from a virtual machine.", "isasync": true, - "name": "createTungstenFabricPolicy", + "name": "detachVolume", "params": [ { - "description": "Tungsten-Fabric policy name", + "description": "the device ID on the virtual machine where volume is detached from", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "deviceid", + "required": false, + "type": "long" }, { - "description": "the ID of zone", + "description": "the ID of the disk volume", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the virtual machine where the volume is detached from", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": false, "type": "uuid" } ], - "related": "listTungstenFabricPolicy,removeTungstenFabricPolicyRule,applyTungstenFabricPolicy,removeTungstenFabricPolicy", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ - {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone name", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "name of the availability zone", "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists Usage Server metrics", - "isasync": false, - "name": "listUsageServerMetrics", - "params": [], - "related": "", - "response": [ { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the name of the active usage server", - "name": "hostname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, - {}, { - "description": "the last time this Usage Server checked for jobs", - "name": "lastheartbeat", + "description": "the date the volume was attached to a VM instance", + "name": "attached", "type": "date" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the state of the usage server", - "name": "state", - "type": "state" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the last time a usage job successfully completed", - "name": "lastsuccessfuljob", - "type": "date" + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" - } - ], - "since": "4.17.0" - }, - { - "description": "Creates a bucket in the specified object storage pool. ", - "isasync": true, - "name": "createBucket", - "params": [ + }, { - "description": "Id of the Object Storage Pool where bucket is created", - "length": 255, - "name": "objectstorageid", - "related": "addObjectStoragePool,listObjectStoragePools", - "required": true, - "type": "uuid" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "Enable bucket encryption", - "length": 255, - "name": "encryption", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "The Bucket access policy", - "length": 255, - "name": "policy", - "required": false, + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "Bucket Quota in GB", - "length": 255, - "name": "quota", - "required": false, - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the account associated with the bucket. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Enable bucket versioning", - "length": 255, - "name": "versioning", - "required": false, + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the name of the bucket", - "length": 255, - "name": "name", - "required": true, + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "Enable object locking in bucket", - "length": 255, - "name": "objectlocking", - "required": false, - "type": "boolean" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain.", - "length": 255, + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the ID of the domain associated with the disk volume", "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the project associated with the bucket. Mutually exclusive with account parameter", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "listBuckets", - "response": [ + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, { - "description": "the domain associated with the bucket", - "name": "domain", + "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", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "Bucket Secret Key", - "name": "usersecretkey", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, - {}, { - "description": "the account associated with the Bucket", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the account associated with the disk volume", "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", + "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": "Bucket Object Locking", - "name": "objectlocking", - "type": "boolean" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, {}, { - "description": "Bucket URL", - "name": "url", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "Bucket Quota in GB", - "name": "quota", - "type": "integer" + "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": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { "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", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -19261,123 +19253,185 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "ID of the Bucket", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "ID of the disk volume", "name": "id", "type": "string" }, { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "State of the Bucket", - "name": "state", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "Bucket Access Key", - "name": "accesskey", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the project id of the bucket", - "name": "projectid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the project name of the bucket", - "name": "project", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "Bucket Access Policy", - "name": "policy", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "Bucket Versioning", - "name": "versioning", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "Object storage provider", - "name": "provider", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "name of the Bucket", - "name": "name", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" } - ], - "since": "4.19.0" + ] }, { - "description": "Lists physical networks", - "isasync": false, - "name": "listPhysicalNetworks", + "description": "Replaces ACL associated with a network or private gateway", + "isasync": true, + "name": "replaceNetworkACLList", "params": [ { - "description": "the Zone ID for the physical network", + "description": "the ID of the network ACL", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", + "required": true, "type": "uuid" }, { - "description": "List by keyword", + "description": "the ID of the network", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "search by name", + "description": "the ID of the private gateway", "length": 255, - "name": "name", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ] + }, + { + "description": "list Tungsten-Fabric address group", + "isasync": false, + "name": "listTungstenFabricAddressGroup", + "params": [ { "description": "", "length": 255, @@ -19385,6 +19439,13 @@ "required": false, "type": "integer" }, + { + "description": "the uuid of Tungsten-Fabric address group", + "length": 255, + "name": "addressgroupuuid", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -19393,33 +19454,41 @@ "type": "integer" }, { - "description": "list physical network by id", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "keyword", "required": false, - "type": "uuid" - } - ], - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "response": [ - { - "description": "zone id of the physical network", - "name": "zoneid", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "createTungstenFabricAddressGroup", + "response": [ + { + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", "type": "string" }, { - "description": "zone name of the physical network", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {}, + { + "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, @@ -19429,65 +19498,162 @@ "type": "integer" }, { - "description": "name of the physical network", + "description": "Tungsten-Fabric address group name", "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" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", + "type": "string" + } + ] + }, + { + "description": "Enables out-of-band management for a zone", + "isasync": true, + "name": "enableOutOfBandManagementForZone", + "params": [ + { + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", + "response": [ + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + { + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + }, + {}, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "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": "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": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + }, {}, { - "description": "comma separated tag", - "name": "tags", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" } ], - "since": "3.0.0" + "since": "4.9.0" }, { - "description": "Enables HA for a zone", - "isasync": true, - "name": "enableHAForZone", + "description": "Lists LDAP Users according to the specifications from the user request.", + "isasync": false, + "name": "listLdapUsers", "params": [ { - "description": "ID of the zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Determines what type of filter is applied on the list of users returned from LDAP.\n\tvalid values are\n\t'NoFilter'\t no filtering is done,\n\t'LocalDomain'\tusers already in the current or requested domain will be filtered out of the result list,\n\t'AnyDomain'\tusers that already exist anywhere in cloudstack will be filtered out, and\n\t'PotentialImport'\tall users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource", + "length": 255, + "name": "userfilter", + "required": false, + "since": "4.13", + "type": "string" + }, + { + "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", + "length": 255, + "name": "listtype", + "required": false, + "type": "string" + }, + { + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], + "related": "searchLdap,importLdapUsers", "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -19495,65 +19661,196 @@ }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The user's domain", + "name": "domain", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The user's username", + "name": "username", + "type": "string" + }, + { + "description": "The user's lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.", + "name": "conflictingusersource", + "type": "string" + }, + { + "description": "The user's principle", + "name": "principal", + "type": "string" + }, + { + "description": "The user's firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "The user's email", + "name": "email", + "type": "string" } ], - "since": "4.11" + "since": "4.2.0" }, { - "description": "Lists all firewall rules for an IP address.", + "description": "Create VM Schedule", "isasync": false, - "name": "listFirewallRules", + "name": "createVMSchedule", "params": [ { - "description": "the ID of IP address of the firewall services", + "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "schedule", + "required": true, + "type": "string" + }, + { + "description": "Description of the schedule", + "length": 255, + "name": "description", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "tags", + "name": "startdate", "required": false, - "type": "map" + "type": "date" }, { - "description": "List by keyword", + "description": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "keyword", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "Enable VM schedule. Defaults to true", + "length": 255, + "name": "enabled", "required": false, + "type": "boolean" + }, + { + "description": "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).", + "length": 255, + "name": "action", + "required": true, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "listall", + "name": "enddate", "required": false, + "type": "date" + }, + { + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "length": 255, + "name": "timezone", + "required": true, + "type": "string" + } + ], + "related": "updateVMSchedule", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Action", + "name": "action", + "type": "action" + }, + { + "description": "Timezone of the schedule", + "name": "timezone", + "type": "string" + }, + { + "description": "VM schedule is enabled", + "name": "enabled", "type": "boolean" }, { - "description": "list firewall rules for certain network", + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + { + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" + }, + {}, + { + "description": "the ID of VM schedule", + "name": "id", + "type": "string" + }, + { + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" + }, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Description of VM schedule", + "name": "description", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "List the IP forwarding rules", + "isasync": false, + "name": "listIpForwardingRules", + "params": [ + { + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.3", "type": "uuid" }, { @@ -19563,6 +19860,13 @@ "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": "", "length": 255, @@ -19571,67 +19875,62 @@ "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "fordisplay", + "name": "listall", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list the rule belonging to this public IP address", "length": 255, - "name": "account", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List by keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "Lists all rules applied to the specified VM.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, { - "description": "Lists rule with the specified ID.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", "required": false, "type": "uuid" } ], - "related": "createFirewallRule,updateEgressFirewallRule", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { @@ -19640,67 +19939,79 @@ "type": "string" }, { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, + {}, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + {}, + { + "description": "the 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": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -19709,18 +20020,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -19729,189 +20040,305 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the traffic type for the firewall rule", - "name": "traffictype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, - {}, - {} - ] - }, - { - "description": "Cleanups VM reservations in the database.", - "isasync": true, - "name": "cleanVMReservations", - "params": [], - "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ] }, { - "description": " delete a Brocade VCS Switch", + "description": "Creates an instant snapshot of a volume.", "isasync": true, - "name": "deleteBrocadeVcsDevice", + "name": "createSnapshot", "params": [ { - "description": "Brocade Switch ID", + "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", "length": 255, - "name": "vcsdeviceid", - "related": "addBrocadeVcsDevice,listBrocadeVcsDevices", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", + "length": 255, + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.19.0", + "type": "list" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Extracts an ISO", - "isasync": true, - "name": "extractIso", - "params": [ + "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "length": 255, + "name": "policyid", + "related": "updateSnapshotPolicy,listSnapshotPolicies", + "required": false, + "type": "uuid" + }, { - "description": "the ID of the ISO file", + "description": "The ID of the disk volume", "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": true, "type": "uuid" }, { - "description": "the ID of the zone where the ISO is originally located", + "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "locationtype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the URL to which the ISO would be extracted", - "length": 2048, - "name": "url", + "description": "asynchronous backup if true", + "length": 255, + "name": "asyncbackup", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "the name of the snapshot", "length": 255, - "name": "mode", - "required": true, + "name": "name", + "required": false, "type": "string" + }, + { + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "quiesce vm if true", + "length": 255, + "name": "quiescevm", + "required": false, + "type": "boolean" } ], - "related": "downloadImageStoreObject,extractTemplate,extractVolume", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", "response": [ + { + "description": "ID of the snapshot", + "name": "id", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + {}, + { + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" }, { - "description": "the state of the extracted object", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" + }, + {}, + { + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", "name": "state", + "type": "state" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "the time and date the object was created", + "description": " the date the snapshot was created", "name": "created", "type": "date" }, { - "description": "the id of extracted object", - "name": "id", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, - {}, - {}, { - "description": "the status of the extraction", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "the status of the template", "name": "status", "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "", - "name": "resultstring", + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" + }, + { + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { @@ -19920,56 +20347,57 @@ "type": "integer" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" } ] }, { - "description": "Lists object storage pools.", + "description": "Lists storage pool metrics", "isasync": false, - "name": "listObjectStoragePools", + "name": "listStoragePoolsMetrics", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -19978,170 +20406,145 @@ "type": "string" }, { - "description": "the ID of the storage pool", + "description": "the Zone ID for the storage pool", "length": 255, - "name": "id", - "related": "addObjectStoragePool,listObjectStoragePools", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the name of the object store", + "description": "the name of the storage pool", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "the object store provider", + "description": "the IP address for the storage pool", "length": 255, - "name": "provider", + "name": "ipaddress", "required": false, "type": "string" - } - ], - "related": "addObjectStoragePool", - "response": [ - {}, - { - "description": "the ID of the object store", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, { - "description": "the url of the object store", - "name": "url", - "type": "string" + "description": "the Pod ID for the storage pool", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the provider name of the object store", - "name": "providername", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" - }, - { - "description": "the total size of the object store", - "name": "storagetotal", - "type": "long" + "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 object store", - "name": "name", + "description": "the status of the storage pool", + "length": 255, + "name": "status", + "required": false, "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "create secondary staging store.", - "isasync": false, - "name": "createSecondaryStagingStore", - "params": [ + }, { - "description": "the details for the staging store", + "description": "", "length": 255, - "name": "details", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the staging store provider name", + "description": "the ID of the storage pool", "length": 255, - "name": "provider", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the Zone ID for the staging store", + "description": "host ID of the storage pools", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "the scope of the staging store: zone only for now", + "description": "the scope of the storage pool", "length": 255, "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, { - "description": "the URL for the staging store", - "length": 2048, - "name": "url", - "required": true, + "description": "the storage pool path", + "length": 255, + "name": "path", + "required": false, "type": "string" + }, + { + "description": "If true, lists the custom stats of the storage pool", + "length": 255, + "name": "storagecustomstats", + "required": false, + "since": "4.18.1", + "type": "boolean" } ], - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "related": "", "response": [ { - "description": "the name of the image store", - "name": "name", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, - {}, - { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, { - "description": "the url of the image store", - "name": "url", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, - {}, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", + "type": "boolean" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "disk size used in GiB", + "name": "disksizeusedgb", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -20149,253 +20552,241 @@ "type": "integer" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, + {}, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ] - }, - { - "description": "Creates an affinity/anti-affinity group", - "isasync": true, - "name": "createAffinityGroup", - "params": [ - { - "description": "domainId of the account owning the affinity group", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "description": "create affinity group for project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "name of the affinity group", - "length": 255, - "name": "name", - "required": true, + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "an account for the affinity group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", "type": "string" }, { - "description": "optional description of the affinity group", - "length": 255, - "name": "description", - "required": false, + "description": "the ID of the storage pool", + "name": "id", "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": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "storage usage disable threshold exceeded", + "name": "storageusagedisablethreshold", + "type": "boolean" + }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, - {}, { - "description": "the name of the affinity group", - "name": "name", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, - {}, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", + "type": "boolean" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "disk size in GiB", + "name": "disksizetotalgb", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - } - ] - }, - { - "description": "Remove a VMware datacenter from a zone.", - "isasync": false, - "name": "removeVmwareDc", - "params": [ + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", + "type": "boolean" + }, { - "description": "The id of Zone from which VMware datacenter has to be removed.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the 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": "any text associated with the success or failure", - "name": "displaytext", - "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": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" } - ] + ], + "since": "4.9.3" }, { - "description": "Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", + "description": "Create a new keypair and returns the private key", "isasync": false, - "name": "oauthlogin", + "name": "createSSHKeyPair", "params": [ { - "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", + "description": "an optional project for the ssh key", "length": 255, - "name": "domainId", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "long" - }, - { - "description": "Name of the provider", - "length": 255, - "name": "provider", - "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "description": "an optional account for the ssh key. Must be used with domainId.", "length": 255, - "name": "secretcode", + "name": "account", "required": false, "type": "string" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "description": "Name of the keypair", "length": 255, - "name": "domain", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "Email id with which user tried to login using OAuth provider", + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "email", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" } ], - "related": "login", + "related": "", "response": [ { - "description": "Username", - "name": "username", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, { - "description": "user time zone", - "name": "timezone", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { - "description": "the account name the user belongs to", - "name": "account", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Private key", + "name": "privatekey", "type": "string" }, { - "description": "User ID", - "name": "userid", + "description": "Name of the keypair", + "name": "name", "type": "string" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { @@ -20404,1475 +20795,929 @@ "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, {}, { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" + "description": "ID of the ssh keypair", + "name": "id", + "type": "string" }, { - "description": "first name of the user", - "name": "firstname", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, + {} + ] + }, + { + "description": "list Tungsten-Fabric service group", + "isasync": false, + "name": "listTungstenFabricServiceGroup", + "params": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "last name of the user", - "name": "lastname", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of zone", + "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": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "the uuid of Tungsten-Fabric service group", + "length": 255, + "name": "servicegroupuuid", + "required": false, "type": "string" + } + ], + "related": "createTungstenFabricServiceGroup", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", "type": "string" }, { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric service group name", + "name": "name", "type": "string" }, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" - } - ], - "since": "4.19.0" + }, + {} + ] }, { - "description": "Lists all available Internal Load Balancer elements.", - "isasync": false, - "name": "listInternalLoadBalancerElements", + "description": "Authorizes a particular egress rule for this security group", + "isasync": true, + "name": "authorizeSecurityGroupEgress", "params": [ { - "description": "List by keyword", + "description": "start port for this egress rule", "length": 255, - "name": "keyword", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list internal load balancer elements by id", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "id", - "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement,listInternalLoadBalancerElements", + "name": "securitygroupname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list internal load balancer elements by enabled state", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "enabled", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "end port for this egress rule", "length": 255, - "name": "pagesize", + "name": "endport", "required": false, "type": "integer" }, { - "description": "", + "description": "user to security group mapping", "length": 255, - "name": "page", + "name": "usersecuritygrouplist", + "required": false, + "type": "map" + }, + { + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "type of the icmp message being sent", + "length": 255, + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "list internal load balancer elements by network service provider id", + "description": "an optional project of the security group", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" + }, + { + "description": "TCP is default. UDP is the other supported protocol", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" + }, + { + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "length": 255, + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", + "required": false, + "type": "uuid" + }, + { + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" } ], - "related": "createInternalLoadBalancerElement,configureInternalLoadBalancerElement", + "related": "authorizeSecurityGroupIngress", "response": [ { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the id of the internal load balancer element", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Updates load balancer health check policy", - "isasync": true, - "name": "updateLBHealthCheckPolicy", - "params": [ + "description": "the code for the ICMP message response", + "name": "icmpcode", + "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", - "required": false, - "since": "4.4", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ID of load balancer health check policy", - "length": 255, - "name": "id", - "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", - "required": true, - "type": "uuid" - } - ], - "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", - "response": [ + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, { - "description": "the list of healthcheckpolicies", - "name": "healthcheckpolicy", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the LB HealthCheck policy ID", - "name": "id", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the description of the healthcheck policy", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "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": "list" + "type": "set" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" - }, + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists storage pools.", + "isasync": false, + "name": "listStoragePools", + "params": [ { - "description": "the account of the HealthCheck policy", - "name": "account", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list storage pools belongig to the specific cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "the name of the storage pool", + "length": 255, + "name": "name", + "required": false, "type": "string" }, - {} - ], - "since": "4.4" - }, - { - "description": "Gets the guest OS names in the hypervisor", - "isasync": true, - "name": "getHypervisorGuestOsNames", - "params": [ { - "description": "Hypervisor type. One of : VMware, XenServer", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "Keyword for guest os name", + "description": "the storage pool path", "length": 255, - "name": "keyword", + "name": "path", "required": false, "type": "string" }, { - "description": "Hypervisor version to get the guest os names (atleast one hypervisor host with the version specified must be available)", + "description": "If true, lists the custom stats of the storage pool", "length": 255, - "name": "hypervisorversion", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the hypervisor", - "name": "hypervisor", - "type": "string" + "name": "storagecustomstats", + "required": false, + "since": "4.18.1", + "type": "boolean" }, { - "description": "version of the hypervisor for guest os names", - "name": "hypervisorversion", + "description": "the status of the storage pool", + "length": 255, + "name": "status", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "host ID of the storage pools", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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 guest OS count of the hypervisor", - "name": "guestoscount", - "type": "integer" + "description": "the scope of the storage pool", + "length": 255, + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "string" }, { - "description": "the guest OS list of the hypervisor", - "name": "guestoslist", - "response": [ - { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", - "type": "string" - }, - { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", - "type": "string" - } - ], - "type": "list" - } - ], - "since": "4.19.0" - }, - { - "description": "remove Tungsten-Fabric policy", - "isasync": true, - "name": "removeTungstenFabricPolicyRule", - "params": [ + "description": "the ID of the storage pool", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, { - "description": "the Uuid of Tungsten-Fabric policy", + "description": "the IP address for the storage pool", "length": 255, - "name": "policyuuid", - "required": true, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the Uuid of Tungsten-Fabric policy rule", + "description": "List by keyword", "length": 255, - "name": "ruleuuid", - "required": true, + "name": "keyword", + "required": false, "type": "string" } ], - "related": "listTungstenFabricPolicy,applyTungstenFabricPolicy,removeTungstenFabricPolicy", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "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": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, - {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, - {}, - {}, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" - } - ] - }, - { - "description": "Create Tungsten-Fabric provider in cloudstack", - "isasync": false, - "name": "createTungstenFabricProvider", - "params": [ + }, { - "description": "Tungsten-Fabric provider introspect port", - "length": 255, - "name": "tungstenproviderintrospectport", - "required": false, + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "Tungsten-Fabric provider port", - "length": 255, - "name": "tungstenproviderport", - "required": false, + "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 ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "Tungsten-Fabric provider hostname", - "length": 255, - "name": "tungstenproviderhostname", - "required": true, + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "Tungsten-Fabric provider gateway", - "length": 255, - "name": "tungstengateway", - "required": true, + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "Tungsten-Fabric provider name", - "length": 255, - "name": "name", - "required": true, + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "Tungsten-Fabric provider vrouter port", - "length": 255, - "name": "tungstenprovidervrouterport", - "required": false, + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" - } - ], - "related": "listTungstenFabricProviders", - "response": [ + }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "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": "Tungsten-Fabric provider name", - "name": "name", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "the 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": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, {}, { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the storage pool", + "name": "name", "type": "string" } ] }, { - "description": "Reboots a virtual machine.", - "isasync": true, - "name": "rebootVirtualMachine", + "description": "Updates a hypervisor capabilities.", + "isasync": false, + "name": "updateHypervisorCapabilities", "params": [ { - "description": "The ID of the virtual machine", + "description": "the hypervisor version for which the hypervisor capabilities are to be updated", "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,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,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "hypervisorversion", + "required": false, + "since": "4.19.1", + "type": "string" }, { - "description": "Force reboot the VM (VM is Stopped and then Started)", + "description": "set true to enable VM snapshots for this hypervisor", "length": 255, - "name": "forced", + "name": "vmsnapshotenabled", "required": false, "since": "4.16.0", "type": "boolean" }, { - "description": "Boot into hardware setup menu or not", + "description": "the hypervisor for which the hypervisor capabilities are to be updated", "length": 255, - "name": "bootintosetup", + "name": "hypervisor", "required": false, - "since": "4.15.0.0", - "type": "boolean" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,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,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ - { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "since": "4.19.1", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "set true to enable storage motion support for this hypervisor", + "length": 255, + "name": "storagemotionenabled", + "required": false, + "since": "4.16.0", + "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the max number of Guest VMs per host for this hypervisor.", + "length": 255, + "name": "maxguestslimit", + "required": false, + "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "length": 255, + "name": "maxdatavolumeslimit", + "required": false, + "since": "4.16.0", + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "ID of the hypervisor capability", + "length": 255, + "name": "id", + "related": "listHypervisorCapabilities,updateHypervisorCapabilities", + "required": false, + "type": "uuid" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the maximum number of the hypervisor hosts per cluster ", + "length": 255, + "name": "maxhostspercluster", + "required": false, + "since": "4.16.0", + "type": "integer" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "set true to enable security group for this hypervisor.", + "length": 255, + "name": "securitygroupenabled", + "required": false, + "type": "boolean" + } + ], + "related": "listHypervisorCapabilities", + "response": [ + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", "type": "long" }, + {}, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" + }, + {}, + { + "description": "the hypervisor type", + "name": "hypervisor", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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 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": "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" - } - ], - "type": "set" - }, - {}, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the ID of the virtual machine", + "description": "the ID of the hypervisor capabilities row", "name": "id", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "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", + "description": "true if storage motion is supported", + "name": "storagemotionenabled", "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "true if security group is supported", + "name": "securitygroupenabled", + "type": "boolean" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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 security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the 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" - } - ], - "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "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" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - } - ], - "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 domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "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" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the 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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the 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": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "ID of the 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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - } - ], - "type": "set" - }, + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "Find hosts suitable for migrating a virtual machine.", + "isasync": false, + "name": "findHostsForMigration", + "params": [ { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "find hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VM", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the speed of each vCPU", + "description": "the CPU speed of the host", "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "type": "long" }, - {}, { - "description": "the state of the virtual machine", - "name": "state", - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, - {}, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the cpu average load on the host", + "name": "averageload", "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", + "description": "the CPU number of the host", "name": "cpunumber", "type": "integer" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "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 resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "long" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the name of the host", + "name": "name", "type": "string" }, { @@ -21881,196 +21726,234 @@ "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "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 VM's disk read in KiB", - "name": "diskkbsread", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, + {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", + "name": "memorywithoverprovisioning", + "type": "string" } ] }, { - "description": "Enables HA cluster-wide", + "description": "Enable a Cisco Nexus VSM device", "isasync": true, - "name": "enableHAForCluster", + "name": "enableCiscoNexusVSM", "params": [ { - "description": "ID of the cluster", + "description": "Id of the Cisco Nexus 1000v VSM device to be enabled", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "id", + "related": "listCiscoNexusVSMs,enableCiscoNexusVSM,disableCiscoNexusVSM", "required": true, "type": "uuid" } ], + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ - {}, { - "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" + }, + { + "description": "device state", + "name": "vsmdevicestate", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" + }, + { + "description": "device 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": "device name", + "name": "vsmdevicename", + "type": "string" + }, + { + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" + }, + {}, + { + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", + "type": "string" + }, + { + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", + "type": "string" } - ], - "since": "4.11" + ] }, { - "description": "Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", + "description": "Return true if the specified account is allowed to create offerings with tags.", "isasync": false, - "name": "addVirtualMachinesToKubernetesCluster", + "name": "isAccountAllowedToCreateOfferingsWithTags", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "Account UUID", "length": 255, "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" - }, - { - "description": "the IDs of the VMs to add to the cluster", - "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,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,deployVnfAppliance,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "list" - }, - { - "description": "Is control node or not? Defaults to false.", - "length": 255, - "name": "iscontrolnode", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "boolean" + "type": "uuid" } ], + "related": "", "response": [ { "description": "the current status of the latest async job acting on this object", @@ -22078,184 +21961,166 @@ "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", + "description": "is domain admin allowed to create offerings with tags", + "name": "isallowed", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ], - "since": "4.19.0" + {} + ] }, { - "description": "Creates a load balancer rule", + "description": "Adds VM to specified network by creating a NIC", "isasync": true, - "name": "createLoadBalancerRule", + "name": "addNicToVirtualMachine", "params": [ { - "description": "the public port from where the network traffic will be load balanced from", + "description": "Network ID", "length": 255, - "name": "publicport", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.", + "description": "DHCP options which are passed to the nic Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com", "length": 255, - "name": "cidrlist", + "name": "dhcpoptions", "required": false, - "since": "4.18.0.0", - "type": "list" + "type": "map" }, { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true", + "description": "Virtual Machine ID", "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "Mac Address for the new network", + "length": 255, + "name": "macaddress", "required": false, "type": "string" }, { - "description": "the domain ID associated with the load balancer", + "description": "IP Address for the new network", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "ipaddress", "required": false, - "type": "uuid" - }, + "type": "string" + } + ], + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "response": [ { - "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", - "length": 255, - "name": "protocol", - "required": false, + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the account associated with the load balancer. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "The guest network this rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": true, + "description": "the format of the template for the virtual machine", + "name": "templateformat", "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 user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "public IP address ID from where the network traffic will be load balanced from", - "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "name of the load balancer rule", - "length": 255, + "description": "the name of the virtual machine", "name": "name", - "required": true, "type": "string" - } - ], - "related": "listLoadBalancerRules,updateLoadBalancerRule", - "response": [ + }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the list of resource tags associated with load balancer", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -22264,336 +22129,384 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" } ], - "type": "list" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "type": "set" }, - {}, { - "description": "the private port", - "name": "privateport", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, + {}, { - "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": "list Tungsten-Fabric logical router", - "isasync": false, - "name": "listTungstenFabricLogicalRouter", - "params": [ { - "description": "the uuid of Tungsten-Fabric logical router", - "length": 255, - "name": "logicalrouteruuid", - "required": false, + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the uuid of Tungsten-Fabric network", - "length": 255, - "name": "networkuuid", - "required": false, + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "createTungstenFabricLogicalRouter,addTungstenFabricNetworkGatewayToLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", - "response": [ - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Tungsten-Fabric logical router name", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "Import vSphere storage policies", - "isasync": false, - "name": "importVsphereStoragePolicies", - "params": [ - { - "description": "ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "listVsphereStoragePolicies", - "response": [ - { - "description": "the ID of the Storage Policy", - "name": "id", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the name of the Storage Policy", - "name": "name", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the description of the Storage Policy", - "name": "description", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, - {}, - {}, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" - } - ] - }, - { - "description": "Adds a guest OS name to hypervisor OS name mapping", - "isasync": true, - "name": "addGuestOsMapping", - "params": [ + }, { - "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", - "length": 255, - "name": "osdisplayname", - "required": false, + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the 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 corresponding network", + "name": "networkid", + "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 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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "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 type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + } + ], + "type": "set" }, { - "description": "Hypervisor type. One of : XenServer, KVM, VMWare", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", - "length": 255, - "name": "osmappingcheckenabled", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "OS name specific to the hypervisor", - "length": 255, - "name": "osnameforhypervisor", - "required": true, + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", - "length": 255, - "name": "forced", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", - "length": 255, - "name": "hypervisorversion", - "required": true, - "type": "string" - } - ], - "related": "updateGuestOsMapping", - "response": [ - {}, - { - "description": "is the mapping user defined", - "name": "isuserdefined", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -22602,274 +22515,622 @@ "type": "integer" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "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 Guest OS type", - "name": "ostypeid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {}, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, + {}, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", - "type": "string" - } - ], - "since": "4.4.0" - }, - { - "description": "Disables out-of-band management for a zone", - "isasync": true, - "name": "disableOutOfBandManagementForZone", - "params": [ - { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "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 type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, + {}, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, - {}, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the operation result description", - "name": "description", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, - {}, { - "description": "the ID of the host", - "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 out-of-band management interface password", - "name": "password", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "List all public, private, and privileged VNF templates.", - "isasync": false, - "name": "listVnfTemplates", - "params": [ - { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", - "length": 255, - "name": "details", - "required": false, - "since": "4.15", - "type": "list" }, { - "description": "the type of the template", - "length": 255, - "name": "templatetype", - "required": false, - "since": "4.19.0", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "list templates by zoneId", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the template ID", - "length": 255, - "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "uuid" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "flag to display the resource image for the templates", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "list datadisk templates by parent template id", - "length": 255, - "name": "parenttemplateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "since": "4.4", - "type": "uuid" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "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, + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", - "length": 255, - "name": "isvnf", - "required": false, - "since": "4.19.0", - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the template name", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "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" + }, + { + "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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 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 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 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 value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + } + ], + "type": "set" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the IDs of the templates, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "since": "4.9", + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", "type": "list" }, { - "description": "If set to true, list only unique templates across zones", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + } + ] + }, + { + "description": "Lists all static routes", + "isasync": false, + "name": "listStaticRoutes", + "params": [ + { + "description": "list static route by id", "length": 255, - "name": "showunique", + "name": "id", + "related": "listStaticRoutes", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -22879,90 +23140,105 @@ "type": "boolean" }, { - "description": "show removed templates as well", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "showremoved", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" - } - ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "list static routes by gateway id", + "length": 255, + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "required": false, + "type": "uuid" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "list static routes by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the ID of the domain to which the template belongs", + "description": "list only resources belonging to the domain specified", + "length": 255, "name": "domainid", - "type": "string" + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "list static routes by vpc id", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the project id of the static route", + "name": "projectid", "type": "string" }, {}, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with static route", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -22971,213 +23247,93 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "set" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "type": "list" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "VPC gateway the route is created for", + "name": "gatewayid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the domain to which the template belongs", + "description": "the domain associated with the static route", "name": "domain", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the template ID", + "description": "the ID of static route", "name": "id", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, - { - "description": "the template name", - "name": "name", + "description": "the account associated with the static route", + "name": "account", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the domain path associated with the static route", + "name": "domainpath", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the account name to which the template belongs", - "name": "account", + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the project name of the template", + "description": "the project name of the static route", "name": "project", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the state of the static route", + "name": "state", "type": "string" }, {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "the account id to which the template belongs", - "name": "accountid", - "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 template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "static route CIDR", + "name": "cidr", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -23185,608 +23341,791 @@ "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, - { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", + "description": "the ID of the domain associated with the static route", + "name": "domainid", "type": "string" } - ], - "since": "4.19.0" + ] }, { - "description": "Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.", - "isasync": true, - "name": "deployVnfAppliance", + "description": "Lists all public ip addresses", + "isasync": false, + "name": "listPublicIpAddresses", "params": [ { - "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,updateSecurityGroup", - "required": false, - "type": "list" - }, - { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "List by keyword", "length": 255, - "name": "networkids", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "", "length": 255, - "name": "startvm", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", + "description": "lists all public IP addresses by zone ID", "length": 255, - "name": "overridediskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.17", "type": "uuid" }, { - "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "iptonetworklist", + "name": "retrieveonlyresourcecount", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "dynamicscalingenabled", + "name": "fordisplay", "required": false, - "since": "4.16", + "since": "4.4", "type": "boolean" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "password", + "name": "listall", "required": false, - "since": "4.19.0.0", - "type": "string" + "type": "boolean" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "list only source NAT IP addresses", "length": 255, - "name": "keypair", + "name": "issourcenat", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "description": "List IPs belonging to the VPC", "length": 255, - "name": "bootmode", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "since": "4.14.0.0", - "type": "string" + "type": "uuid" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "nicmultiqueuenumber", + "name": "isrecursive", "required": false, - "since": "4.18", - "type": "integer" + "type": "boolean" }, { - "description": "the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0.", + "description": "lists all public IP addresses by state", "length": 255, - "name": "vnfcidrlist", + "name": "state", "required": false, - "type": "list" + "type": "string" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "description": "lists all public IP addresses by VLAN ID", "length": 255, - "name": "copyimagetags", + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, - "since": "4.13", - "type": "boolean" + "type": "uuid" }, { - "description": "True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.", + "description": "list only IPs used for load balancing", "length": 255, - "name": "vnfconfiguremanagement", + "name": "forloadbalancing", "required": false, "type": "boolean" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "details", + "name": "tags", "required": false, - "since": "4.3", "type": "map" }, { - "description": "the mac address for default vm's network", + "description": "limits search results to allocated public IP addresses", "length": 255, - "name": "macaddress", + "name": "allocatedonly", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "lists IP address by ID", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "id", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18", - "type": "map" - }, - { - "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "datadiskofferinglist", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.11", - "type": "map" + "type": "uuid" }, { - "description": "host name for the virtual machine", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "lists all public IP addresses by source network ID", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "list" + "since": "4.13.0", + "type": "uuid" }, { - "description": "the ipv6 address for default vm's network", + "description": "true if range is dedicated for system VMs", "length": 255, - "name": "ip6address", + "name": "forsystemvms", "required": false, - "type": "string" + "since": "4.20.0", + "type": "boolean" }, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "description": "the virtual network for the IP address", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ip address for default vm's network", + "description": "lists all public IP addresses associated to the network specified", "length": 255, - "name": "ipaddress", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "list only static NAT IP addresses", "length": 255, - "name": "keypairs", + "name": "isstaticnat", "required": false, - "since": "4.17", - "type": "list" + "type": "boolean" }, { - "description": "the ID of the Userdata", + "description": "lists all public IP addresses by physical network ID", "length": 255, - "name": "userdataid", - "related": "", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "since": "4.18", "type": "uuid" }, { - "description": "an optional group for the virtual machine", + "description": "", "length": 255, - "name": "group", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Deploy vm for the project", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "description": "lists the specified IP address", "length": 255, - "name": "keyboard", + "name": "ipaddress", "required": false, "type": "string" - }, + } + ], + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "response": [ { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", - "required": false, - "since": "4.12", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, + {}, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", - "length": 255, - "name": "affinitygroupnames", - "related": "", - "required": false, - "type": "list" - }, - { - "description": "availability zone for the virtual machine", - "length": 255, + "description": "the ID of the zone the public IP address belongs to", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, "type": "string" }, { - "description": "an optional user generated name for the virtual machine", - "length": 255, - "name": "displayname", - "required": false, - "type": "string" + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid", - "length": 255, - "name": "nicnetworklist", - "required": false, - "since": "4.15", - "type": "map" + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", + "type": "string" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", - "length": 255, - "name": "deploymentplanner", - "required": false, - "since": "4.4", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "used to specify the vApp properties.", - "length": 255, - "name": "properties", - "required": false, - "since": "4.15", - "type": "map" + "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.", - "length": 255, - "name": "displayvm", - "required": false, - "since": "4.2", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", - "length": 255, - "name": "size", - "required": false, - "type": "long" + "description": "public IP address id", + "name": "id", + "type": "string" }, { - "description": "Enable packed virtqueues or not.", - "length": 255, - "name": "nicpackedvirtqueuesenabled", - "required": false, - "since": "4.18", + "description": "is public IP portable across the zones", + "name": "isportable", "type": "boolean" }, { - "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", - "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup,updateSecurityGroup", - "required": false, - "type": "list" + "description": "the project id of the ipaddress", + "name": "projectid", + "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, + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "Controls specific policies on IO", - "length": 255, - "name": "iodriverpolicy", - "required": false, + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", - "length": 255, - "name": "dhcpoptionsnetworklist", - "required": false, - "type": "map" + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" }, + {}, { - "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", - "length": 255, - "name": "iothreadsenabled", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", - "length": 255, - "name": "boottype", - "required": false, - "since": "4.14.0.0", + "description": "public IP address", + "name": "ipaddress", "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": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "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, + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "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", + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" }, { - "description": "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, + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" + }, + { + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the list of resource tags associated with ip address", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Lists OpenDyalight controllers", + "isasync": false, + "name": "listOpenDaylightControllers", + "params": [ + { + "description": "the Physical Network ID", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of a OpenDaylight Controller", + "length": 255, + "name": "id", + "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", + "required": false, "type": "uuid" } ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,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,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "addOpenDaylightController,deleteOpenDaylightController", "response": [ { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the url of the controller api", + "name": "url", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "device id of the controller", + "name": "id", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Adds a BigSwitch BCF Controller device", + "isasync": true, + "name": "addBigSwitchBcfDevice", + "params": [ + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, + { + "description": "NAT support of the BigSwitch BCF Controller.", + "length": 255, + "name": "nat", + "required": true, "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Password of the BigSwitch BCF Controller.", + "length": 255, + "name": "password", + "required": true, + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "Username of the BigSwitch BCF Controller.", + "length": 255, + "name": "username", + "required": true, "type": "string" + } + ], + "related": "listBigSwitchBcfDevices", + "response": [ + {}, + {}, + { + "description": "NAT support", + "name": "nat", + "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the controller username", + "name": "username", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the controller password", + "name": "password", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the controller Ip address", + "name": "hostname", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" + } + ], + "since": "4.6.0" + }, + { + "description": "Changes the default NIC on a VM", + "isasync": true, + "name": "updateDefaultNicForVirtualMachine", + "params": [ + { + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "NIC ID", + "length": 255, + "name": "nicid", + "related": "listNics", + "required": true, + "type": "uuid" + } + ], + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "response": [ + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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" }, + { + "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 ID of the security group", - "name": "id", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "account owning the security group rule", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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 account associated with the tag", "name": "account", "type": "string" }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "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 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", @@ -23796,24 +24135,19 @@ "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, { "description": "resource type", "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -23822,18 +24156,23 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -23842,40 +24181,75 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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 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 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 name of the security group", - "name": "name", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the list of virtualmachine ids associated with this securitygroup", @@ -23887,9 +24261,14 @@ "name": "egressrule", "response": [ { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the starting IP of the security group rule", @@ -23897,37 +24276,42 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -23936,28 +24320,33 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], @@ -23968,11 +24357,6 @@ "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", @@ -23982,180 +24366,260 @@ "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of 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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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" } ], "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" } ], "type": "set" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + {}, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "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 AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the project name where tag belongs to", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project name of the affinity group", "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account owning the affinity group", "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "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": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project name of the vm", - "name": "project", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { @@ -24163,13 +24627,13 @@ "name": "nic", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -24178,83 +24642,73 @@ "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the nic", - "name": "id", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "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 broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -24262,332 +24716,301 @@ "name": "ipaddresses", "type": "list" }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, { "description": "public IP address associated with this nic via Static nat rule", "name": "publicip", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - } - ], - "type": "set" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" } ], "type": "set" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "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 ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, - {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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", + "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 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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, - {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "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 list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { "description": "the outgoing network traffic on the host in KiB", @@ -24595,696 +25018,671 @@ "type": "long" }, { - "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 name of userdata used for the VM", - "name": "userdataname", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" } - ], - "since": "4.19.0" + ] }, { - "description": "Updates a network offering.", + "description": "Generate DRS plan for a cluster", "isasync": false, - "name": "updateNetworkOffering", + "name": "generateClusterDrsPlan", "params": [ { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 4096, - "name": "zoneid", - "required": false, - "since": "4.13", - "type": "string" - }, - { - "description": "update state for the network offering", - "length": 255, - "name": "state", - "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": "sort key of the network offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, - { - "description": "maximum number of concurrent connections supported by the network offering", + "description": "Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting", "length": 255, - "name": "maxconnections", + "name": "migrations", "required": false, "type": "integer" }, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", - "required": false, - "type": "string" - }, - { - "description": "the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required ", - "length": 255, - "name": "availability", - "required": false, - "type": "string" - }, - { - "description": "the id of the network offering", + "description": "the ID of the Cluster", "length": 255, "name": "id", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", - "required": false, + "related": "addCluster,updateCluster", + "required": true, "type": "uuid" - }, + } + ], + "related": "executeClusterDrsPlan", + "response": [ { - "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": "List of migrations", + "name": "migrations", + "type": "list" }, { - "description": "the name of the network offering", - "length": 255, - "name": "name", - "required": false, + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, { - "description": "the display text of the network offering", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ], - "related": "createNetworkOffering,listNetworkOfferings", - "response": [ + }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" + "description": "Start event Id of the DRS Plan", + "name": "eventid", + "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, - { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", - "type": "string" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, + {}, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, - {}, + {} + ], + "since": "4.19.0" + }, + { + "description": "Deletes a user for an account", + "isasync": false, + "name": "deleteUser", + "params": [ { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" - }, + "description": "id of the user to be deleted", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" + } + ], + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the name of the network offering", - "name": "name", - "type": "string" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ] + }, + { + "description": "Initiates the specified power action to the host's out-of-band management interface", + "isasync": true, + "name": "issueOutOfBandManagementPowerAction", + "params": [ { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the host", + "length": 255, + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, + "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", + "length": 255, + "name": "timeout", + "required": false, + "type": "long" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - }, - { - "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" - } - ], - "type": "list" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, + {}, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "the operation result", + "name": "status", "type": "boolean" }, + {}, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "the id of the network offering", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" } - ] + ], + "since": "4.9.0" }, { - "description": "Lists all IPv6 firewall rules", - "isasync": false, - "name": "listIpv6FirewallRules", + "description": "Create a new Shared File System of specified size and disk offering, attached to the given network", + "isasync": true, + "name": "createSharedFileSystem", "params": [ { - "description": "", + "description": "the name of the shared filesystem.", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "name", + "required": true, + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the domain ID associated with the shared filesystem. If used with the account parameter returns the shared filesystem associated with the account for the specified domain.If account is NOT provided then the shared filesystem will be assigned to the caller account and domain.", "length": 255, - "name": "tags", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the description for the shared filesystem.", "length": 255, - "name": "account", + "name": "description", "required": false, "type": "string" }, { - "description": "", + "description": "the disk offering to use for the underlying storage. This will define the size and other specifications like encryption and qos for the shared filesystem.", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the zone id.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", "length": 255, - "name": "fordisplay", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list ipv6 firewall rules by network ID", + "description": "max iops", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "maxiops", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "filesystem", + "required": true, + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the size of the shared filesystem in GiB", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "size", "required": false, + "type": "long" + }, + { + "description": "network to attach the shared filesystem to", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, "type": "uuid" }, { - "description": "Lists ipv6 firewall rule with the specified ID", + "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "min iops", "length": 255, - "name": "keyword", + "name": "miniops", "required": false, - "type": "string" + "type": "long" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the service offering to use for the shared filesystem instance hosting the data. The offering should be HA enabled and the cpu count and memory size should be greater than equal to sharedfsvm.min.cpu.count and sharedfsvm.min.ram.size respectively", "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "description": "the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API.", "length": 255, - "name": "traffictype", + "name": "provider", "required": false, "type": "string" } ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ + {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", "name": "networkid", "type": "string" }, - {}, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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": "tag key name", - "name": "key", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 ID of the nic", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the type of the nic", + "name": "type", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the 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 ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - } - ] - }, - { - "description": "Stops a system VM.", - "isasync": true, - "name": "stopSystemVm", - "params": [ - { - "description": "The ID of the system virtual machine", - "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", - "required": true, - "type": "uuid" - }, - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - } - ], - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "response": [ - { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", - "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + } + ], + "type": "list" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { "description": "the current status of the latest async job acting on this object", @@ -25292,199 +25690,169 @@ "type": "integer" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, - {}, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, - {}, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, + {}, { - "description": "the systemvm agent version", - "name": "version", - "type": "string" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the ID of the system VM", - "name": "id", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "ID of the availability zone", + "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", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the system VM", + "description": "name of the shared filesystem", "name": "name", "type": "string" }, { - "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 Zone ID for the system VM", - "name": "zoneid", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" } - ] + ], + "since": "4.20.0" }, { - "description": "Deletes an egress firewall rule", - "isasync": true, - "name": "deleteEgressFirewallRule", + "description": "Deletes network device.", + "isasync": false, + "name": "deleteNetworkDevice", "params": [ { - "description": "the ID of the firewall rule", + "description": "Id of network device to delete", "length": 255, "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" } @@ -25501,204 +25869,106 @@ "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ] }, { - "description": "Updates a VPC", - "isasync": true, - "name": "updateVPC", + "description": "Updates image store read-only status", + "isasync": false, + "name": "updateImageStore", "params": [ { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC", - "length": 255, - "name": "sourcenatipaddress", - "required": false, - "since": "4.19", - "type": "string" - }, - { - "description": "an optional field, whether to the display the vpc to the end user or not", + "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", "length": 255, - "name": "fordisplay", + "name": "readonly", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "the id of the VPC", - "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" - }, - { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", - "type": "integer" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "The number of bytes CloudStack can use on this image storage.\n\tNOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage.", "length": 255, - "name": "customid", + "name": "capacitybytes", "required": false, - "since": "4.4", - "type": "string" + "type": "long" }, { - "description": "the name of the VPC", + "description": "The new name for the Image Store.", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "the display text of the VPC", + "description": "Image Store UUID", "length": 255, - "name": "displaytext", - "required": false, - "type": "string" + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "required": true, + "type": "uuid" } ], - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" - }, - {}, - { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, + {}, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the url of the image store", + "name": "url", + "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, - {}, { - "description": "zone id of the vpc", + "description": "the Zone ID of the image store", "name": "zoneid", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "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", @@ -25706,351 +25976,294 @@ "type": "integer" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the id of the VPC", + "description": "the ID of the image store", "name": "id", "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" }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", + "isasync": true, + "name": "assignToLoadBalancerRule", + "params": [ { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", + "length": 255, + "name": "virtualmachineids", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": false, + "type": "list" }, { - "description": "the name of the VPC", - "name": "name", - "type": "string" + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75", + "length": 255, + "name": "vmidipmap", + "required": false, + "since": "4.4", + "type": "map" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "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": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ] + }, + { + "description": "Lists all pending asynchronous jobs for the account.", + "isasync": false, + "name": "listAsyncJobs", + "params": [ { - "description": "the owner of the VPC", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, "name": "account", + "required": false, "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" + "description": "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 routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "The id of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": false, + "since": "4.19", + "type": "uuid" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } - ] - }, - { - "description": "Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password", - "isasync": true, - "name": "changeOutOfBandManagementPassword", - "params": [ - { - "description": "the ID of the host", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, "type": "uuid" }, { - "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", "length": 255, - "name": "password", + "name": "startdate", "required": false, - "type": "string" + "type": "date" } ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,issueOutOfBandManagementPowerAction", + "related": "queryAsyncJobResult", "response": [ { - "description": "the current status of the latest async job acting on this object", + "description": "the result type", + "name": "jobresulttype", + "type": "string" + }, + { + "description": "the domain that executed the async command", + "name": "domainpath", + "type": "string" + }, + { + "description": "the current job status-should be 0 for PENDING", "name": "jobstatus", "type": "integer" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account that executed the async command", + "name": "account", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the async command executed", + "name": "cmd", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": " the created date of the job", + "name": "created", + "type": "date" }, { - "description": "the operation result description", - "name": "description", + "description": "the domain id that executed the async command", + "name": "domainid", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" }, {}, - {}, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "List VM Schedules.", - "isasync": false, - "name": "listVMSchedule", - "params": [ - { - "description": "ID of VM schedule", - "length": 255, - "name": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", - "required": false, - "type": "uuid" + "description": " the completed date of the job", + "name": "completed", + "type": "date" }, { - "description": "Action taken by schedule", - "length": 255, - "name": "action", - "required": false, + "description": "the account id that executed the async command", + "name": "accountid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, + {} + ] + }, + { + "description": "Archive one or more alerts.", + "isasync": false, + "name": "archiveAlerts", + "params": [ { - "description": "ID of the VM for which schedule is to be defined", + "description": "the IDs of the alerts", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "ids", + "related": "listAlerts,listAlertTypes", + "required": false, + "type": "list" }, { - "description": "", + "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": "pagesize", + "name": "enddate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "", + "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": "page", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "ID of VM schedule", + "description": "archive by alert type", "length": 255, - "name": "enabled", + "name": "type", "required": false, - "type": "boolean" + "type": "string" } ], - "related": "createVMSchedule,updateVMSchedule", "response": [ { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" - }, - { - "description": "Description of VM schedule", - "name": "description", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Action", - "name": "action", - "type": "action" - }, - { - "description": "the ID of VM schedule", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, - { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -26058,14 +26271,32 @@ }, {}, { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Deletes a Cisco Vnmc controller", + "isasync": false, + "name": "deleteCiscoVnmcResource", + "params": [ { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "Cisco Vnmc resource ID", + "length": 255, + "name": "resourceid", + "related": "addCiscoVnmcResource,listCiscoVnmcResources", + "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", @@ -26073,176 +26304,177 @@ "type": "integer" }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" } - ], - "since": "4.19.0" + ] }, { - "description": "List resource detail(s)", + "description": "Creates a secondary storage selector, described by the heuristic rule.", "isasync": false, - "name": "listResourceDetails", + "name": "createSecondaryStorageSelector", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list by key", + "description": "The description of the heuristic rule.", "length": 255, - "name": "key", - "required": false, + "name": "description", + "required": true, "type": "string" }, { - "description": "List by keyword", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", "length": 255, - "name": "keyword", - "required": false, + "name": "type", + "required": true, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "The zone in which the heuristic rule will be applied.", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "list by key, value. Needs to be passed only along with key", + "description": "The name identifying the heuristic rule.", "length": 255, - "name": "value", - "required": false, - "since": "4.4", + "name": "name", + "required": true, "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": "if set to true, only details marked with display=true, are returned. False by default", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.3", - "type": "boolean" - }, + "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", + "length": 65535, + "name": "heuristicrule", + "required": true, + "type": "string" + } + ], + "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", + "response": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "ID of the heuristic.", + "name": "id", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, + {}, { - "description": "list by resource id", - "length": 255, - "name": "resourceid", - "required": false, + "description": "When the heuristic was created.", + "name": "created", + "type": "date" + }, + { + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" }, { - "description": "list by resource type", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "Name of the heuristic.", + "name": "name", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "listTags", - "response": [ + "description": "Description of the heuristic.", + "name": "description", + "type": "string" + }, { - "description": "tag key name", - "name": "key", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", "type": "string" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Adds a Brocade VCS Switch", + "isasync": true, + "name": "addBrocadeVcsDevice", + "params": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "Credentials to access the Brocade VCS Switch API", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Hostname of ip address of the Brocade VCS Switch.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Credentials to access the Brocade VCS Switch API", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" + } + ], + "related": "listBrocadeVcsDevices", + "response": [ + { + "description": "the principal switch Ip address", + "name": "hostname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "device name", + "name": "brocadedevicename", "type": "string" }, - {}, - {}, { - "description": "tag value", - "name": "value", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" }, { @@ -26251,101 +26483,93 @@ "type": "integer" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "name of the provider", + "name": "provider", "type": "string" - } - ], - "since": "4.2" + }, + {}, + {} + ] }, { - "description": "Attempts to live patch systemVMs - CPVM, SSVM ", + "description": "Deleting resource tag(s)", "isasync": true, - "name": "patchSystemVm", + "name": "deleteTags", "params": [ { - "description": "patches systemVM - CPVM/SSVM with the specified ID", + "description": "Delete tags for resource id(s)", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": false, - "type": "uuid" + "name": "resourceids", + "required": true, + "type": "list" }, { - "description": "If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only", + "description": "Delete tags matching key/value pairs", "length": 255, - "name": "forced", + "name": "tags", "required": false, - "type": "boolean" + "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" }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], - "since": "4.17.0" + "since": "4.0.0" }, { - "description": "Dedicate an existing cluster", + "description": "create Tungsten-Fabric tag type", "isasync": true, - "name": "dedicateCluster", + "name": "createTungstenFabricTagType", "params": [ { - "description": "the ID of the Cluster", + "description": "the ID of zone", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, { - "description": "the ID of the containing domain", + "description": "Tungsten-Fabric tag type name", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "name", "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", + "related": "listTungstenFabricTagType", "response": [ { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, - {}, - {}, - { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { @@ -26353,409 +26577,280 @@ "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 cluster", - "name": "clustername", - "type": "string" - }, - { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "Tungsten-Fabric tag type name", + "name": "name", "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, { - "description": "Creates a network offering.", - "isasync": false, - "name": "createNetworkOffering", + "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", + "isasync": true, + "name": "restartNetwork", "params": [ { - "description": "true if network offering supports vlans", - "length": 255, - "name": "specifyvlan", - "required": false, - "type": "boolean" - }, - { - "description": "desired service capabilities as part of network offering", - "length": 255, - "name": "servicecapabilitylist", - "required": false, - "type": "map" - }, - { - "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 network offering, defaults to the value of 'name'.", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", + "description": "If cleanup old network elements", "length": 255, - "name": "fortungsten", + "name": "cleanup", "required": false, "type": "boolean" }, { - "description": "the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks ", + "description": "The ID of the network to restart.", "length": 255, - "name": "availability", - "required": false, - "type": "string" + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "true if the network offering is IP conserve mode enabled", + "description": "Turn the network into a network with redundant routers.", "length": 255, - "name": "conservemode", + "name": "makeredundant", "required": false, + "since": "4.11.1", "type": "boolean" }, { - "description": "true if network offering is meant to be used for VPC, false otherwise.", + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, - "name": "forvpc", + "name": "livepatch", "required": false, + "since": "4.17.0", "type": "boolean" - }, + } + ], + "response": [ { - "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", - "length": 255, - "name": "internetprotocol", - "required": false, - "since": "4.17.0", + "description": "any text associated with the success or failure", + "name": "displaytext", "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" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the name of the network offering", - "length": 255, - "name": "name", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "data transfer rate in megabits per second allowed", - "length": 255, - "name": "networkrate", - "required": false, - "type": "integer" - }, - { - "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", - "length": 255, - "name": "details", - "required": false, - "since": "4.2.0", - "type": "map" - }, - { - "description": "maximum number of concurrent connections supported by the network offering", - "length": 255, - "name": "maxconnections", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - }, - { - "description": "the service offering ID used by virtual router provider", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" - }, + } + ] + }, + { + "description": "Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", + "isasync": false, + "name": "login", + "params": [ { - "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", + "description": "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": "keepaliveenabled", + "name": "domain", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "guest type of the network offering: Shared or Isolated", + "description": "Username", "length": 255, - "name": "guestiptype", + "name": "username", "required": true, "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "length": 255, - "name": "egressdefaultpolicy", - "required": false, - "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": "set to true if the offering is to be enabled during creation. Default is false", + "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", "length": 255, - "name": "enable", - "required": false, - "since": "4.16", - "type": "boolean" - }, - { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", + "name": "domainId", "required": false, - "type": "string" + "type": "long" }, { - "description": "the traffic type for the network offering. Supported type in current release is GUEST only", + "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": "traffictype", + "name": "password", "required": true, "type": "string" - }, + } + ], + "related": "oauthlogin", + "response": [ { - "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", - "length": 255, - "name": "specifyipranges", - "required": false, - "type": "boolean" + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", + "type": "string" }, { - "description": "services supported by the network offering", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", + "type": "string" }, { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", - "length": 255, - "name": "ispersistent", - "required": false, - "type": "boolean" - } - ], - "related": "listNetworkOfferings", - "response": [ - { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "user time zoneoffset", + "name": "timezoneoffset", + "type": "string" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the account name the user belongs to", + "name": "account", + "type": "string" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "first name of the user", + "name": "firstname", + "type": "string" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", + "description": "the time period before the session has expired", + "name": "timeout", "type": "integer" }, + {}, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "user time zone", + "name": "timezone", + "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "User ID", + "name": "userid", "type": "string" }, { - "description": "the name of the network offering", - "name": "name", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "Username", + "name": "username", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Is two factor authentication verified", + "name": "is2faverified", + "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "Domain ID that the user belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "last name of the user", + "name": "lastname", "type": "string" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "Two factor authentication provider", + "name": "providerfor2fa", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Is user registered", + "name": "registered", "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, + {}, { - "description": "the tags for the network offering", - "name": "tags", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists all hypervisor capabilities.", + "isasync": false, + "name": "listHypervisorCapabilities", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "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": "ID of the hypervisor capability", + "length": 255, + "name": "id", + "related": "listHypervisorCapabilities", + "required": false, + "type": "uuid" }, { - "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": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - } - ], - "type": "list" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "the hypervisor type", + "name": "hypervisor", + "type": "string" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -26763,223 +26858,170 @@ "type": "integer" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", + "description": "true if security group is supported", + "name": "securitygroupenabled", "type": "boolean" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the ID of the hypervisor capabilities row", + "name": "id", "type": "string" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", + "type": "boolean" }, {}, { - "description": "the id of the network offering", - "name": "id", - "type": "string" + "description": "true if storage motion is supported", + "name": "storagemotionenabled", + "type": "boolean" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" - } + "description": "the maximum number of Hosts per cluster for this hypervisor", + "name": "maxhostspercluster", + "type": "integer" + }, + {} ], "since": "3.0.0" }, { - "description": "Creates an IP forwarding rule", - "isasync": true, - "name": "createIpForwardingRule", + "description": "Delete Project roles in CloudStack", + "isasync": false, + "name": "deleteProjectRole", "params": [ { - "description": "the end port for the rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, - { - "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", - "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" - }, - { - "description": "the start port for the rule", - "length": 255, - "name": "startport", - "required": true, - "type": "integer" - }, - { - "description": "the protocol for the rule. Valid values are TCP or UDP.", + "description": "ID of the project from where the role is to be deleted", "length": 255, - "name": "protocol", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the public IP address ID of the forwarding rule, already associated via associateIp", + "description": "ID of the project role to be deleted", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "id", + "related": "createProjectRole,listProjectRoles,updateProjectRole", "required": true, "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" } ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", "response": [ - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Get SolidFire Account ID", + "isasync": false, + "name": "getSolidFireAccountId", + "params": [ { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "CloudStack Account UUID", + "length": 255, + "name": "accountid", + "required": true, "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "Storage Pool UUID", + "length": 255, + "name": "storageid", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ + {}, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "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": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "SolidFire Account ID", + "name": "solidFireAccountId", + "type": "long" + } + ] + }, + { + "description": "Lists role permissions", + "isasync": false, + "name": "listRolePermissions", + "params": [ + { + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", + "type": "string" }, - {}, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -26987,66 +27029,61 @@ "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, + {}, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "Lists volume metrics", + "description": "Lists dedicated guest vlan ranges", "isasync": false, - "name": "listVolumesMetrics", + "name": "listDedicatedGuestVlanRanges", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "the dedicated guest vlan range", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "guestvlanrange", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list volumes on specified host", + "description": "", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the cluster id the disk volume belongs to", + "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": "clusterid", - "related": "addCluster,updateCluster", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "physical network id of the guest VLAN range", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "project who will own the guest VLAN range", "length": 255, "name": "projectid", "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", @@ -27054,38 +27091,29 @@ "type": "uuid" }, { - "description": "the type of disk volume", + "description": "", "length": 255, - "name": "type", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the virtual machine", + "description": "list dedicated guest vlan ranges by id", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,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,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "id", + "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", "required": false, "type": "uuid" }, { - "description": "the IDs of the volumes, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": false, - "since": "4.9", - "type": "list" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "listall", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the availability zone", + "description": "zone of the guest VLAN range", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -27093,250 +27121,268 @@ "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "displayvolume", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" + } + ], + "related": "dedicateGuestVlanRange", + "response": [ + { + "description": "the account of the guest VLAN range", + "name": "account", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", - "length": 255, - "name": "state", - "required": false, + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the pod id the disk volume belongs to", - "length": 255, - "name": "podid", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the domain ID of the guest VLAN range", + "name": "domainid", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the project name of the guest vlan range", + "name": "project", + "type": "string" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" + "description": "the guest VLAN range", + "name": "guestvlanrange", + "type": "string" }, { - "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", + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" + }, + { + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" }, { - "description": "the name of the disk volume", - "length": 255, - "name": "name", - "required": false, + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" + }, + {} + ] + }, + { + "description": "Lists all network ACL items", + "isasync": false, + "name": "listNetworkACLs", + "params": [ + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "listsystemvms", + "name": "isrecursive", "required": false, - "since": "4.18", "type": "boolean" }, { - "description": "List by keyword", + "description": "list network ACL items by protocol", "length": 255, - "name": "keyword", + "name": "protocol", "required": false, "type": "string" }, { - "description": "list volumes by disk offering", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "account", + "name": "tags", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ + "type": "map" + }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "Lists network ACL Item with the specified ID", + "length": 255, + "name": "id", + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "required": false, + "type": "uuid" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "list network ACL items by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "the path of the volume", - "name": "path", + "description": "list network ACL items by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "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 status of the volume", - "name": "status", - "type": "string" + "description": "list network ACL items by ACL ID", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", + "required": false, + "type": "uuid" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "list network ACL items by action", + "length": 255, + "name": "action", + "required": false, "type": "string" - }, + } + ], + "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", + "response": [ { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, { - "description": "disk size in GiB", - "name": "sizegb", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", - "type": "long" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, + {}, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "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", + "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -27345,8 +27391,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -27355,448 +27401,433 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" } ], - "type": "set" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "type": "list" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "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", - "type": "integer" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "is rule for display to the regular user", + "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ] + }, + { + "description": "Copies a template from one zone to another.", + "isasync": true, + "name": "copyTemplate", + "params": [ { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "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": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "Template ID.", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "ID of the zone the template is being copied to.", + "length": 255, + "name": "destzoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, + "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", + "length": 255, + "name": "sourcezoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, + {}, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "name of the disk volume", - "name": "name", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - } - ], - "since": "4.9.3" - }, - { - "description": "Lists the network Interfaces of elastistor", - "isasync": false, - "name": "listElastistorInterface", - "params": [ - { - "description": "controller id", - "length": 255, - "name": "controllerid", - "required": false, + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" - } - ], - "related": "listElastistorVolume", - "response": [ + }, { - "description": "graceallowed", - "name": "graceallowed", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "synchronization", - "name": "sync", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "compression", - "name": "compression", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the name of the volume", + "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": "deduplication", - "name": "deduplication", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the id of the volume", - "name": "id", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Lists all possible details and their options for a resource type such as a VM or a template", - "isasync": false, - "name": "listDetailOptions", - "params": [ + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, { - "description": "the UUID of the resource (optional)", - "length": 255, - "name": "resourceid", - "required": false, + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the resource type such as UserVm, Template etc.", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "Map of all possible details and their possible list of values", - "name": "details", - "type": "map" + "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" - } - ], - "since": "4.13" - }, - { - "description": "Lists SSL certificates", - "isasync": false, - "name": "listSslCerts", - "params": [ { - "description": "Load balancer rule ID", - "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": false, - "type": "uuid" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "Account ID", - "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "ID of SSL certificate", - "length": 255, - "name": "certid", - "related": "uploadSslCert,listSslCerts", - "required": false, - "type": "uuid" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "Project that owns the SSL certificate", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "uploadSslCert", - "response": [ - { - "description": "name", - "name": "name", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "certificate", - "name": "certificate", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the project name of the certificate", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "SSL certificate ID", - "name": "id", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "certificate fingerprint", - "name": "fingerprint", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "certificate chain", - "name": "certchain", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "account for the certificate", - "name": "account", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { @@ -27805,60 +27836,27 @@ "type": "integer" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, - {} + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + } ] }, { - "description": "List private gateways", + "description": "lists network that are using a nicira nvp device", "isasync": false, - "name": "listPrivateGateways", + "name": "listNiciraNvpDeviceNetworks", "params": [ - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "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,createPrivateGateway,listPrivateGateways", - "required": false, - "type": "uuid" - }, - { - "description": "list gateways 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", - "required": false, - "type": "boolean" - }, { "description": "List by keyword", "length": 255, @@ -27867,27 +27865,13 @@ "type": "string" }, { - "description": "list gateways by vpc", + "description": "nicira nvp device ID", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "required": true, "type": "uuid" }, - { - "description": "list gateways by vlan", - "length": 255, - "name": "vlan", - "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": "", "length": 255, @@ -27895,21 +27879,6 @@ "required": false, "type": "integer" }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -27918,78 +27887,67 @@ "type": "integer" } ], - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the network implementation uri for the private gateway", - "name": "vlan", - "type": "string" - }, - { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" - }, - { - "description": "the account associated with the private gateway", - "name": "account", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "ACL name set for private gateway", - "name": "aclname", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -27997,205 +27955,355 @@ "type": "integer" }, { - "description": "the gateway", + "description": "the network's gateway", "name": "gateway", "type": "string" }, { - "description": "the project name of the private gateway", - "name": "project", + "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 the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, - {} - ] - }, - { - "description": "Update the default Ip of a VM Nic", - "isasync": true, - "name": "updateVmNicIp", - "params": [ { - "description": "Secondary IP Address", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "ACL Id associated with the VPC network", + "name": "aclid", "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" - } - ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, + {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "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": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, {}, { - "description": "the project name of the vm", - "name": "project", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, - {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the owner of the network", + "name": "account", "type": "string" }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the list of resource tags associated", + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -28204,1633 +28312,965 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the project name of the address", + "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", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the project id of the ipaddress", + "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": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "VNF details", - "name": "vnfdetails", + "description": "the details of the network", + "name": "details", "type": "map" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + } + ] + }, + { + "description": " delete a BigSwitch BCF Controller device", + "isasync": true, + "name": "deleteBigSwitchBcfDevice", + "params": [ + { + "description": "BigSwitch device ID", + "length": 255, + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.6.0" + }, + { + "description": "Lists all available ovs elements.", + "isasync": false, + "name": "listOvsElements", + "params": [ { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "list ovs elements by id", + "length": 255, + "name": "id", + "related": "listOvsElements,configureOvsElement", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "list network offerings by enabled state", + "length": 255, + "name": "enabled", + "required": false, "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "list ovs elements by network service provider id", + "length": 255, + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "required": false, + "type": "uuid" }, { - "description": "the project id of the vm", - "name": "projectid", + "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" + } + ], + "related": "configureOvsElement", + "response": [ + { + "description": "the id of the ovs", + "name": "id", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the domain associated with the provider", + "name": "domain", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" + } + ] + }, + { + "description": "associate a profile to a blade", + "isasync": true, + "name": "associateUcsProfileToBlade", + "params": [ + { + "description": "blade id", + "length": 255, + "name": "bladeid", + "related": "associateUcsProfileToBlade", + "required": true, + "type": "uuid" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "profile dn", + "length": 255, + "name": "profiledn", + "required": true, "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "ucs manager id", + "length": 255, + "name": "ucsmanagerid", + "related": "listUcsManagers,addUcsManager", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "ucs blade id", + "name": "id", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "ucs manager id", + "name": "ucsmanagerid", + "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 value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain 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 egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the 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 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 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" - } - ], - "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 domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "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 project id of the group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "ucs blade dn", + "name": "bladedn", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, + {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, {}, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Updates a VMware datacenter details for a zone", + "isasync": false, + "name": "updateVmwareDc", + "params": [ + { + "description": "The username required to connect to resource.", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "VMware datacenter name.", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The password for specified username.", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "The zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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" + } + ], + "related": "addVmwareDc,listVmwareDcs", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, + {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "The VMware vCenter name/ip", + "name": "vcenter", + "type": "string" + } + ], + "since": "4.12.0" + }, + { + "description": "Checks the 2FA code for the user.", + "isasync": false, + "name": "validateUserTwoFactorAuthenticationCode", + "params": [ + { + "description": "two factor authentication code", + "length": 255, + "name": "codefor2fa", + "required": true, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.18.0" + }, + { + "description": "Starts a router.", + "isasync": false, + "name": "getRouterHealthCheckResults", + "params": [ { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "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 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": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "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": "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", + "length": 255, + "name": "performfreshchecks", + "required": false, + "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, + "description": "the ID of the router", + "length": 255, + "name": "routerid", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the id of the router", + "name": "routerid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the id of the router", + "name": "healthchecks", + "type": "list" } - ] + ], + "since": "4.14.0" }, { - "description": "Updates load balancer stickiness policy", - "isasync": true, - "name": "updateLBStickinessPolicy", + "description": "list control center", + "isasync": false, + "name": "listNetscalerControlCenter", "params": [ { - "description": "an optional field, whether to the display the policy to the end user or not", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "id of lb stickiness policy", + "description": "", "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "", "length": 255, - "name": "customid", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" } ], - "related": "createLBStickinessPolicy,listLBStickinessPolicies", + "related": "", "response": [ { - "description": "the domain of the Stickiness policy", - "name": "domain", - "type": "string" - }, - { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "username", + "name": "username", "type": "string" }, { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", - "response": [ - { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, - { - "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 name of the Stickiness policy", - "name": "name", - "type": "string" - }, - { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "ncc_ip", + "name": "ipaddress", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "num_retries", + "name": "numretries", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "id", + "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 Stickiness policy", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {} - ], - "since": "4.4" + { + "description": "uuid", + "name": "uuid", + "type": "string" + } + ] }, { - "description": "Lists all Pods.", - "isasync": false, - "name": "listPods", + "description": "Resizes a volume", + "isasync": true, + "name": "resizeVolume", "params": [ { - "description": "list Pods by ID", - "length": 255, - "name": "id", - "related": "listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "list Pods by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "New maximum number of IOPS", "length": 255, - "name": "pagesize", + "name": "maxiops", "required": false, - "type": "integer" + "type": "long" }, { - "description": "", + "description": "New minimum number of IOPS", "length": 255, - "name": "page", + "name": "miniops", "required": false, - "type": "integer" + "type": "long" }, { - "description": "list Pods by Zone ID", + "description": "the ID of the disk volume", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, "type": "uuid" }, { - "description": "flag to display the capacity of the pods", + "description": "Verify OK to Shrink", "length": 255, - "name": "showcapacities", + "name": "shrinkok", "required": false, "type": "boolean" }, { - "description": "list pods by allocation state", + "description": "new disk offering id", "length": 255, - "name": "allocationstate", + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "New volume size in GB", "length": 255, - "name": "keyword", + "name": "size", "required": false, - "type": "string" + "type": "long" } ], - "related": "updatePod,createManagementNetworkIpRange", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the path of the volume", + "name": "path", "type": "string" }, - {}, - {}, { - "description": "the name of the Pod", - "name": "name", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "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 gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - } - ], - "type": "list" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the ID of the Pod", - "name": "id", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "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 starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", - "name": "startip", - "type": "list" - }, - { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "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": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the capacity of the Pod", - "name": "capacity", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the Pod name", - "name": "podname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" } ], - "type": "list" - } - ] - }, - { - "description": "Starts an existing internal lb vm.", - "isasync": true, - "name": "startInternalLoadBalancerVM", - "params": [ - { - "description": "the ID of the internal lb vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ + "type": "set" + }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "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 link local IP address for the router", - "name": "linklocalip", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the 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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - } - ], - "type": "set" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "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": "the public netmask for the router", - "name": "publicnetmask", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { @@ -29839,420 +29279,346 @@ "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", "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": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the project id of the ipaddress", + "description": "the project id of the vpn", "name": "projectid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the id of the router", - "name": "id", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, + {}, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" } ] }, { - "description": "Updates a disk offering.", - "isasync": false, - "name": "updateDiskOffering", + "description": "Deletes affinity group", + "isasync": true, + "name": "deleteAffinityGroup", "params": [ { - "description": "bytes write rate of the disk offering", + "description": "the account of the affinity group. Must be specified with domain ID", "length": 255, - "name": "byteswriterate", + "name": "account", "required": false, - "since": "4.15", - "type": "long" + "type": "string" }, { - "description": "io requests write rate of the disk offering", + "description": "the domain ID of account owning the affinity group", "length": 255, - "name": "iopswriterate", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.15", - "type": "long" + "type": "uuid" }, { - "description": "burst bytes write rate of the disk offering", + "description": "The ID of the affinity group. Mutually exclusive with name parameter", "length": 255, - "name": "byteswriteratemax", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "since": "4.13", - "type": "string" + "type": "uuid" }, { - "description": "updates name of the disk offering with this value", + "description": "The name of the affinity group. Mutually exclusive with ID parameter", "length": 255, "name": "name", "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": "length (in seconds) of the burst", + "description": "the project of the affinity group", "length": 255, - "name": "bytesreadratemaxlength", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.15", - "type": "long" - }, + "type": "uuid" + } + ], + "response": [ { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", - "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the cache mode to use for this disk offering", - "length": 255, - "name": "cachemode", - "required": false, - "since": "4.15", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "sort key of the disk offering, integer", - "length": 255, - "name": "sortkey", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopswriteratemaxlength", - "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Deletes a network offering.", + "isasync": false, + "name": "deleteNetworkOffering", + "params": [ { - "description": "ID of the disk offering", + "description": "the ID of the network offering", "length": 255, "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": true, "type": "uuid" - }, + } + ], + "response": [ { - "description": "updates alternate display text of the disk offering with this value", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, + {}, { - "description": "burst requests read rate of the disk offering", - "length": 255, - "name": "iopsreadratemax", - "required": false, - "since": "4.15", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "burst io requests write rate of the disk offering", - "length": 255, - "name": "iopswriteratemax", - "required": false, - "since": "4.15", - "type": "long" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "Dedicates a Pod.", + "isasync": true, + "name": "dedicatePod", + "params": [ { - "description": "length (in seconds) of the burst", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "byteswriteratemaxlength", + "name": "account", "required": false, - "since": "4.15", - "type": "long" + "type": "string" }, { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "description": "the ID of the Pod", "length": 255, - "name": "tags", - "required": false, - "since": "4.15", - "type": "string" + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "burst bytes read rate of the disk offering", + "description": "the ID of the containing domain", "length": 255, - "name": "bytesreadratemax", - "required": false, - "since": "4.15", - "type": "long" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" } ], - "related": "createDiskOffering,listDiskOfferings", + "related": "listDedicatedPods", "response": [ { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" - }, - { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" - }, - { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the ID of the Pod", + "name": "podid", + "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", + "type": "string" }, + {}, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" - }, + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", + "type": "string" + } + ] + }, + { + "description": "Update a Storage network IP range, only allowed when no IPs in this range have been allocated.", + "isasync": true, + "name": "updateStorageNetworkIpRange", + "params": [ { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "UUID of storage network ip range", + "length": 255, + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the ending IP address", + "length": 255, + "name": "endip", + "required": false, + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "Optional. the vlan the ip range sits on", + "length": 255, + "name": "vlan", + "required": false, + "type": "integer" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "the netmask for storage network", + "length": 255, + "name": "netmask", + "required": false, + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the beginning IP address", + "length": 255, + "name": "startip", + "required": false, "type": "string" - }, + } + ], + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "response": [ { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, + {}, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "the network uuid of storage network IP range", + "name": "networkid", + "type": "string" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "the uuid of storage network IP range.", + "name": "id", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -30260,91 +29626,45 @@ "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "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", - "type": "long" - }, - {}, - { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "the name of the disk offering", - "name": "name", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "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 gateway of the storage network IP range", + "name": "gateway", "type": "string" - }, - { - "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" } - ] + ], + "since": "3.0.0" }, { - "description": "delete Tungsten-Fabric address group", - "isasync": true, - "name": "deleteTungstenFabricAddressGroup", + "description": "Synchronize Tungsten-Fabric data", + "isasync": false, + "name": "synchronizeTungstenFabricData", "params": [ { - "description": "the uuid of Tungsten-Fabric address group", - "length": 255, - "name": "addressgroupuuid", - "required": true, - "type": "string" - }, - { - "description": "the ID of zone", + "description": "provider id", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "createTungstenFabricProvider,listTungstenFabricProviders", "required": true, "type": "uuid" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -30361,106 +29681,51 @@ "name": "success", "type": "boolean" }, - {} - ] - }, - { - "description": "Stops a running CloudManaged Kubernetes cluster", - "isasync": true, - "name": "stopKubernetesCluster", - "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ] }, { - "description": "Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", - "isasync": false, - "name": "removeVirtualMachinesFromKubernetesCluster", + "description": "Purge expunged resources", + "isasync": true, + "name": "purgeExpungedResources", "params": [ { - "description": "", + "description": "The end date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", "length": 255, - "name": "page", + "name": "enddate", "required": false, - "type": "integer" - }, - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" + "type": "date" }, { - "description": "the IDs of the VMs to remove from the cluster", + "description": "The size of batch used during purging", "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "list" + "name": "batchsize", + "required": false, + "type": "long" }, { - "description": "List by keyword", + "description": "The type of the resource which need to be purged. Supported types: VirtualMachine", "length": 255, - "name": "keyword", + "name": "resourcetype", "required": false, "type": "string" }, { - "description": "", + "description": "The start date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", "length": 255, - "name": "pagesize", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" } ], - "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -30469,302 +29734,167 @@ "type": "boolean" }, {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} - ], - "since": "4.19.0" - }, - { - "description": "Adds account to a project", - "isasync": true, - "name": "addAccountToProject", - "params": [ - { - "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 role", - "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": false, - "type": "uuid" - }, - { - "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" - }, - { - "description": "name of the account to be added to the project", - "length": 255, - "name": "account", - "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" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {} + } ], - "since": "3.0.0" + "since": "4.20" }, { - "description": "Lists all available snapshots for the account.", - "isasync": false, - "name": "listSnapshots", + "description": "Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering", + "isasync": true, + "name": "changeOfferingForVolume", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "New volume size in GB for the custom disk offering", "length": 255, - "name": "isrecursive", + "name": "size", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "ID of the image or image cache store", + "description": "the ID of the volume", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": false, - "since": "4.19", + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", + "name": "maxiops", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "new disk offering id", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, "type": "uuid" }, { - "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", + "description": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "locationtype", + "name": "miniops", "required": false, - "since": "4.19.0", - "type": "string" + "type": "long" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "Verify OK to Shrink", "length": 255, - "name": "listall", + "name": "shrinkok", "required": false, "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", "length": 255, - "name": "account", + "name": "automigrate", "required": false, - "type": "string" - }, + "type": "boolean" + } + ], + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "response": [ { - "description": "lists snapshot by snapshot name", - "length": 255, - "name": "name", - "required": false, + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "ID of the storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.19", - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", "type": "map" }, { - "description": "If set to false, list templates across zones and their storages", - "length": 255, - "name": "showunique", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "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": "valid values are MANUAL or RECURRING.", - "length": 255, - "name": "snapshottype", - "required": false, + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "list snapshots by zone id", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", - "length": 255, - "name": "intervaltype", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the IDs of the snapshots, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", - "required": false, - "since": "4.9", - "type": "list" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "lists snapshot by snapshot ID", - "length": 255, - "name": "id", - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", - "required": false, - "type": "uuid" - } - ], - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", - "response": [ - { - "description": "the project name of the snapshot", - "name": "project", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { "description": "name of the disk volume", - "name": "volumename", + "name": "name", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -30778,13 +29908,18 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -30793,572 +29928,545 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "id of the os on volume", - "name": "ostypeid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, - {}, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the path of the volume", + "name": "path", "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, - {}, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - } - ] - }, - { - "description": "delete Tungsten-Fabric logical router", - "isasync": true, - "name": "deleteTungstenFabricLogicalRouter", - "params": [ + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the uuid of Tungsten-Fabric logical router", - "length": 255, - "name": "logicalrouteruuid", - "required": true, + "description": "the disk utilization", + "name": "utilization", "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", + "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": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "pod name of the volume", + "name": "podname", "type": "string" - } - ] - }, - { - "description": "Reset site to site vpn connection", - "isasync": true, - "name": "resetVpnConnection", - "params": [ + }, { - "description": "an optional account for connection. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "an optional domainId for connection. 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": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "id of vpn connection", - "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections,resetVpnConnection,updateVpnConnection", - "required": true, - "type": "uuid" - } - ], - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", - "response": [ - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, - {}, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, - {}, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, + {}, { - "description": "the owner", - "name": "account", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the project name", - "name": "project", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" } - ] + ], + "since": "4.17" }, { - "description": "migrates resources from one secondary storage to destination image store", - "isasync": true, - "name": "migrateResourceToAnotherSecondaryStorage", + "description": "Remove an Ldap Configuration", + "isasync": false, + "name": "deleteLdapConfiguration", "params": [ { - "description": "id of the image store from where the data is to be migrated", + "description": "port", "length": 255, - "name": "srcpool", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" + "name": "port", + "required": false, + "type": "integer" }, { - "description": "id of the destination secondary storage pool to which the resources are to be migrated", + "description": "Hostname", "length": 255, - "name": "destpool", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "name": "hostname", "required": true, - "type": "uuid" - }, - { - "description": "id(s) of the templates to be migrated", - "length": 255, - "name": "templates", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "list" + "type": "string" }, { - "description": "id(s) of the snapshots to be migrated", + "description": "linked domain", "length": 255, - "name": "snapshots", - "related": "createSnapshot,createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "list" + "type": "uuid" } ], - "related": "migrateSecondaryStorageData", + "related": "addLdapConfiguration,listLdapConfigurations", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "linked domain", + "name": "domainid", + "type": "string" }, + {}, { - "description": "Response message from migration of secondary storage data objects", - "name": "message", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Type of migration requested for", - "name": "migrationtype", + "description": "name of the host running the ldap server", + "name": "hostname", "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": "port the ldap server is running on", + "name": "port", + "type": "int" } ], - "since": "4.19.0" + "since": "4.2.0" }, { - "description": "Lists Kubernetes clusters", + "description": "Creates a Project role", "isasync": false, - "name": "listKubernetesClusters", + "name": "createProjectRole", "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 by keyword", + "description": "The description of the Project role", "length": 255, - "name": "keyword", + "name": "description", "required": false, "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "ID of project where role is being created", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": true, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "creates a project role with this unique name", "length": 255, - "name": "listall", - "required": false, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "listProjectRoles,updateProjectRole", + "response": [ + { + "description": "the name of the role", + "name": "name", + "type": "string" + }, + { + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the description of the role", + "name": "description", + "type": "string" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the UUID of the latest async job acting on 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 Kubernetes cluster", - "length": 255, + "description": "the ID of the role", "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": false, - "type": "uuid" + "type": "string" }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Creates an Ipv6 firewall rule in the given network (the network must not belong to VPC)", + "isasync": true, + "name": "createIpv6FirewallRule", + "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "type of the ICMP message being sent", "length": 255, - "name": "page", + "name": "icmptype", "required": false, "type": "integer" }, { - "description": "state of the Kubernetes cluster", + "description": "the starting port of Ipv6 firewall rule", "length": 255, - "name": "state", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "name", - "required": false, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "The network of the VM the Ipv6 firewall rule will be created for", "length": 255, - "name": "clustertype", - "required": false, - "since": "4.19.0", - "type": "string" + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "destcidrlist", "required": false, - "type": "uuid" - } - ], - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "response": [ - { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", "type": "list" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "the ending port of Ipv6 firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" - }, + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + } + ], + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "response": [ { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { @@ -31367,456 +30475,486 @@ "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, - { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, - {}, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "list" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "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 network of the Kubernetes cluster", - "name": "networkid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced", + "isasync": false, + "name": "triggerShutdown", + "params": [ { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "the uuid of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" + } + ], + "related": "cancelShutdown,prepareForShutdown,readyForShutdown", + "response": [ + {}, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "type": "boolean" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "The number of jobs in progress", + "name": "pendingjobscount", "type": "long" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", - "type": "string" + "description": "The id of the management server", + "name": "managementserverid", + "type": "long" }, + {}, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Updates a network", + "isasync": true, + "name": "updateNetwork", + "params": [ { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", - "type": "string" + "description": "Setting this to true will cause a forced network update,", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", + "length": 255, + "name": "dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", + "length": 255, + "name": "ip6dns1", + "required": false, + "since": "4.18.0", "type": "string" }, - {} - ] - }, - { - "description": "Deletes a keypair by name", - "isasync": false, - "name": "deleteSSHKeyPair", - "params": [ { - "description": "the project associated with keypair", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "privatemtu", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "integer" }, { - "description": "the account associated with the keypair. Must be used with the domainId parameter.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "account", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "the domain ID associated with the keypair", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", + "name": "displaynetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Name of the keypair", + "description": "the new name for the network", "length": 255, "name": "name", - "required": true, + "required": false, "type": "string" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "network domain", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", + "description": "the new display text for the network", + "length": 255, "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", - "isasync": true, - "name": "createAutoScaleVmGroup", - "params": [ - { - "description": "list of scaledown autoscale policies", + "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": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "name": "updateinsequence", + "required": false, + "type": "boolean" }, { - "description": "list of scaleup autoscale policies", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "list" + "name": "publicmtu", + "required": false, + "since": "4.18.0", + "type": "integer" }, { - "description": "the name of the autoscale vmgroup", + "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", "length": 255, - "name": "name", + "name": "ip6dns2", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "description": "the ID of the network", "length": 255, - "name": "minmembers", + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "the frequency in which the performance counters to be collected", + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", "length": 255, - "name": "interval", + "name": "hideipaddressusage", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", + "description": "Force update even if CIDR type is different", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" + "name": "changecidr", + "required": false, + "type": "boolean" }, { - "description": "an optional field, whether to the display the group to the end user or not", + "description": "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", "length": 255, - "name": "fordisplay", + "name": "dns1", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "the ID of the load balancer rule", + "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", + "type": "string" + }, + { + "description": "network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, "type": "uuid" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", "length": 255, - "name": "maxmembers", - "required": true, - "type": "integer" + "name": "guestvmcidr", + "required": false, + "type": "string" } ], - "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "zone id of the network", + "name": "zoneid", + "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "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 public ip address id", - "name": "publicipid", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, + {}, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "The external id of the network", + "name": "externalid", + "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the domain ID of the vm group", - "name": "domainid", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the public port", - "name": "publicport", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "the project name of the vm group", - "name": "project", + "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 minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, - { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the private port", - "name": "privateport", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, - {}, { - "description": "the public ip address", - "name": "publicip", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", - "type": "string" - } - ] - }, - { - "description": "Searches LDAP based on the username attribute", - "isasync": false, - "name": "searchLdap", - "params": [ - { - "description": "query to search using", - "length": 255, - "name": "query", - "related": "searchLdap,listLdapUsers", - "required": true, + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "listLdapUsers", - "response": [ + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, { - "description": "The user's lastname", - "name": "lastname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { @@ -31825,1474 +30963,1864 @@ "type": "integer" }, { - "description": "The user's email", - "name": "email", + "description": "the type of the network", + "name": "type", "type": "string" }, - {}, - {}, { - "description": "The user's firstname", - "name": "firstname", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "The user's username", - "name": "username", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "The user's domain", - "name": "domain", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "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": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "The user's principle", - "name": "principal", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown", - "isasync": false, - "name": "readyForShutdown", - "params": [ - { - "description": "the uuid of the management server", - "length": 255, - "name": "managementserverid", - "related": "listManagementServers", - "required": false, - "type": "uuid" - } - ], - "related": "prepareForShutdown,triggerShutdown", - "response": [ - { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "the details of the network", + "name": "details", + "type": "map" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" - }, - { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" - } - ], - "since": "4.19.0" - }, - { - "description": "Deletes a load balancer rule.", - "isasync": true, - "name": "deleteLoadBalancerRule", - "params": [ - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "add a baremetal ping pxe server", - "isasync": true, - "name": "addBaremetalPxePingServer", - "params": [ - { - "description": "Pod Id", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "Password of PING storage server", - "length": 255, - "name": "pingcifspassword", - "required": false, + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "password", - "required": true, + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "type of pxe device", - "length": 255, - "name": "pxeservertype", - "required": true, + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "Username of PING storage server", - "length": 255, - "name": "pingcifsusername", - "required": false, + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "username", - "required": true, - "type": "string" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" }, { - "description": "Tftp root directory of PXE server", - "length": 255, - "name": "tftpdir", - "required": true, - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "Root directory on PING storage server", - "length": 255, - "name": "pingdir", - "required": true, + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "URL of the external pxe device", - "length": 255, - "name": "url", - "required": true, + "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": "PING storage server ip", - "length": 255, - "name": "pingstorageserverip", - "required": true, + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Root directory on PING storage server", - "name": "pingdir", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, - {}, { - "description": "device id of ", - "name": "id", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "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 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 id of the network", + "name": "id", "type": "string" }, { - "description": "url", - "name": "url", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "PING storage server ip", - "name": "pingstorageserverip", - "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": "name of the provider", - "name": "provider", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" - } - ] - }, - { - "description": "create Tungsten-Fabric logical router", - "isasync": true, - "name": "createTungstenFabricLogicalRouter", - "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" }, { - "description": "Tungsten-Fabric logical router name", - "length": 255, - "name": "name", - "required": true, + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" - } - ], - "related": "addTungstenFabricNetworkGatewayToLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", - "response": [ + }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, - {}, { - "description": "Tungsten-Fabric logical router name", - "name": "name", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - } - ] - }, - { - "description": "create Tungsten-Fabric firewall", - "isasync": true, - "name": "createTungstenFabricFirewallRule", - "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "Tungsten-Fabric firewall rule direction", - "length": 255, - "name": "direction", - "required": true, - "type": "string" - }, - { - "description": "the sequence of Tungsten-Fabric firewall rule", - "length": 255, - "name": "sequence", - "required": true, - "type": "integer" - }, - { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", - "required": true, - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule action", - "length": 255, - "name": "action", - "required": true, + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag uuid", - "length": 255, - "name": "desttaguuid", - "required": false, + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, + {}, { - "description": "the uuid of Tungsten-Fabric source network", - "length": 255, - "name": "srcnetworkuuid", - "required": false, + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source tag uuid", - "length": 255, - "name": "srctaguuid", - "required": false, + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type uuid", - "length": 255, - "name": "tagtypeuuid", - "required": false, + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group uuid", - "length": 255, - "name": "servicegroupuuid", - "required": true, + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group uuid", - "length": 255, - "name": "srcaddressgroupuuid", - "required": false, - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the uuid of Tungsten-Fabric destination network", - "length": 255, - "name": "destnetworkuuid", - "required": false, - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "Tungsten-Fabric firewall rule destination address group uuid", - "length": 255, - "name": "destaddressgroupuuid", - "required": false, - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" } - ], - "related": "listTungstenFabricFirewallRule", + ] + }, + { + "description": "List Usage Types", + "isasync": false, + "name": "listUsageTypes", + "params": [], + "related": "", "response": [ - {}, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", - "type": "string" - }, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "description": "Usage type description", + "name": "description", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", + "description": "Usage type name", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", - "type": "string" + "description": "Usage type ID", + "name": "id", + "type": "integer" }, + {} + ] + }, + { + "description": "Deletes a VPC", + "isasync": true, + "name": "deleteVPC", + "params": [ { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", - "type": "string" - }, + "description": "the ID of the VPC", + "length": 255, + "name": "id", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "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": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", - "type": "string" - }, {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "list portable IP ranges", - "isasync": false, - "name": "listPortableIpRanges", + "description": "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool", + "isasync": true, + "name": "migrateVirtualMachine", "params": [ { - "description": "Id of a Region", - "length": 255, - "name": "regionid", - "required": false, - "type": "integer" - }, - { - "description": "Id of the portable ip range", + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, - "name": "id", - "related": "createPortableIpRange,listPortableIpRanges", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "", + "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": "page", + "name": "autoselect", "required": false, - "type": "integer" + "since": "4.16.0", + "type": "boolean" }, { - "description": "List by keyword", + "description": "the ID of the virtual machine", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "Destination Host ID to migrate VM to.", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "createPortableIpRange", + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ - {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "portable IP range ID", - "name": "id", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", - "name": "portableipaddress", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "VPC the ip belongs to", - "name": "vpcid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain ID the portable IP address is associated with", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], - "type": "list" + "type": "set" }, + {}, { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the start ip of the portable IP range", - "name": "startip", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the end ip of the portable IP range", - "name": "endip", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Returns user data associated with the VM", - "isasync": false, - "name": "getVirtualMachineUserData", - "params": [ - { - "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,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "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 cidr of IPv6 network", + "name": "ip6cidr", + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the 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 gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "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 type of the nic", + "name": "type", + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + } + ], + "type": "set" }, { - "description": "Base 64 encoded VM user data", - "name": "userdata", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.4" - }, - { - "description": "Updates network permissions.", - "isasync": false, - "name": "createNetworkPermissions", - "params": [ - { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "list" - }, { - "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "accounts", - "required": false, - "type": "list" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "accountids", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, - "type": "list" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", + "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.17.0" - }, - { - "description": "Lists all configurations.", - "isasync": false, - "name": "listConfigurations", - "params": [ - { - "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 of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the 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 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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the 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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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 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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the 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": "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "lists configuration by name", - "length": 255, - "name": "name", - "required": false, + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "lists configurations by category", - "length": 255, - "name": "category", - "required": false, + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "lists configuration by parent name (primarily used for UI)", - "length": 255, - "name": "parent", - "required": false, - "since": "4.18.0", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "lists configuration by group name (primarily used for UI)", - "length": 255, - "name": "group", - "required": false, - "since": "4.18.0", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the ID of the Domain to update the parameter value for corresponding domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": false, - "type": "uuid" - }, - { - "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "lists configuration by subgroup name (primarily used for UI)", - "length": 255, - "name": "subgroup", - "required": false, - "since": "4.18.0", - "type": "string" - } - ], - "related": "updateConfiguration", - "response": [ - { - "description": "the display text of the configuration", - "name": "displaytext", + "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 description of the configuration", - "name": "description", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the value of the configuration", - "name": "id", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the group of the configuration", - "name": "group", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, - {}, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the component of the configuration", - "name": "component", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, - {}, { - "description": "the value of the configuration", - "name": "value", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the name of the configuration", - "name": "name", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" - } - ] - }, - { - "description": "Disables static rule for given IP address", - "isasync": true, - "name": "disableStaticNat", - "params": [ - { - "description": "the public IP address ID for which static NAT feature is being disabled", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, - {} - ] - }, - { - "description": "Assigns secondary IP to NIC", - "isasync": true, - "name": "addIpToNic", - "params": [ { - "description": "Secondary IP Address", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the user's name who deployed the virtual machine", + "name": "username", "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" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the secondary private IP addr", - "name": "id", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the ID of the nic", - "name": "nicid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, - {}, { - "description": "the list of Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the vm", - "name": "virtualmachineid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the network", - "name": "networkid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "Secondary IP address", - "name": "ipaddress", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" - } - ] - }, - { - "description": "Scales a created, running or stopped CloudManaged Kubernetes cluster", - "isasync": true, - "name": "scaleKubernetesCluster", - "params": [ - { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" - }, - { - "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": "Whether autoscaling is enabled for the cluster", - "length": 255, - "name": "autoscalingenabled", - "required": false, - "type": "boolean" - }, - { - "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,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "list" }, { - "description": "Minimum number of worker nodes in the cluster", - "length": 255, - "name": "minsize", - "required": false, - "type": "long" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "number of Kubernetes cluster nodes", - "length": 255, - "name": "size", - "required": false, - "type": "long" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "Maximum number of worker nodes in the cluster", - "length": 255, - "name": "maxsize", - "required": false, - "type": "long" - } - ], - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", - "response": [ - { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "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", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", + "description": "the name of the domain in which the virtual machine exists", "name": "domain", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" - }, - { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "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 project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "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 ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the ID of the 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 Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - {}, - { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, - {}, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "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 Kubernetes cluster", - "name": "serviceofferingid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "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 name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" } ] }, { - "description": "Stops a NetScalervm.", + "description": "Deletes a Kubernetes cluster", "isasync": true, - "name": "stopNetScalerVpx", + "name": "deleteKubernetesSupportedVersion", "params": [ { - "description": "the ID of the NetScaler vm", + "description": "the ID of the Kubernetes supported version", "length": 255, "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, "type": "uuid" - }, - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], - "related": "destroyRouter,listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "list baremetal rack configuration", + "isasync": false, + "name": "listBaremetalRct", + "params": [ { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "role of the domain router", - "name": "role", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "addBaremetalRct", + "response": [ { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "url", + "name": "url", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "id of rct", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ] + }, + { + "description": "Lists available certificate authority providers in CloudStack", + "isasync": false, + "name": "listCAProviders", + "params": [ { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, + "description": "List CA service provider by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + {}, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the description of the CA service provider", + "name": "description", "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 ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the CA service provider name", + "name": "name", "type": "string" - }, + } + ], + "since": "4.11.0" + }, + { + "description": "Delete site to site vpn customer gateway", + "isasync": true, + "name": "deleteVpnCustomerGateway", + "params": [ + { + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the 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": "Lists all port forwarding rules for an IP address.", + "isasync": false, + "name": "listPortForwardingRules", + "params": [ + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "Lists rule with the specified ID.", + "length": 255, + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "required": false, + "type": "uuid" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "list port forwarding rules for certain network", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "since": "4.3", + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "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": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of IP address of the port forwarding services", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" + } + ], + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "response": [ + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { @@ -33301,451 +32829,365 @@ "type": "integer" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "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 template ID for the router", - "name": "templateid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "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 ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" } ], - "type": "set" + "type": "list" }, { - "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 account associated with the router", - "name": "account", - "type": "string" - }, + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } + ] + }, + { + "description": "Allocates IP addresses in respective Pod of a Zone", + "isasync": false, + "name": "acquirePodIpAddress", + "params": [ { - "description": "the Pod name for the router", - "name": "podname", + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": "Pod ID", + "length": 255, + "name": "podid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "CIDR of the Pod", + "name": "cidr", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" + "description": "the ID of the nic", + "name": "nicid", + "type": "long" }, + {}, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "Gateway for Pod ", + "name": "gateway", "type": "string" }, {}, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "MAC address of the pod the IP", + "name": "hostmac", + "type": "long" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" - }, - { - "description": "result of the health check", - "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 ID of the pod the IP address", + "name": "id", + "type": "long" }, { - "description": "the project name of the address", - "name": "project", + "description": "Allocated IP address", + "name": "ipaddress", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, + "description": "the ID of the pod the IP address belongs to", + "name": "podid", + "type": "long" + } + ] + }, + { + "description": "Enables out-of-band management for a cluster", + "isasync": true, + "name": "enableOutOfBandManagementForCluster", + "params": [ { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ + { + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, + {}, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ] - }, - { - "description": "Delete a Ucs manager", - "isasync": false, - "name": "deleteUcsManager", - "params": [ + }, { - "description": "ucs manager id", - "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "Deletes a host.", + "description": "Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.", "isasync": false, - "name": "deleteHost", + "name": "updateTemplatePermissions", "params": [ { - "description": "the host ID", + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" + "name": "accounts", + "required": false, + "type": "list" }, { - "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": "true for featured template/iso, false otherwise", "length": 255, - "name": "forced", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "forcedestroylocalstorage", + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" - } - ], - "response": [ + "type": "list" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template ID", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "permission operator (add, remove, reset)", + "length": 255, + "name": "op", + "required": false, "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Deletes a vm group", - "isasync": false, - "name": "deleteInstanceGroup", - "params": [ { - "description": "the ID of the instance group", + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", - "required": true, - "type": "uuid" + "name": "isextractable", + "required": false, + "type": "boolean" } ], "response": [ @@ -33754,1017 +33196,512 @@ "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" - }, - {}, {} ] }, { - "description": "deletes the resource icon from the specified resource(s)", - "isasync": false, - "name": "deleteResourceIcon", + "description": "Resets the password for virtual machine. The virtual machine must be in a \"Stopped\" state and the template must already support this feature for this command to take effect. [async]", + "isasync": true, + "name": "resetPasswordForVirtualMachine", "params": [ { - "description": "type of the resource", + "description": "The new password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "resourcetype", - "required": true, + "name": "password", + "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "list of resources to upload the icon/image for", + "description": "The ID of the virtual machine", "length": 255, - "name": "resourceids", + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": true, - "type": "list" + "type": "uuid" } ], + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "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", + "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.16.0.0" - }, - { - "description": "Lists capabilities", - "isasync": false, - "name": "listCapabilities", - "params": [], - "related": "", - "response": [ - { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", - "type": "boolean" - }, - { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", - "type": "boolean" - }, - { - "description": "true if users can see all accounts within the same domain, false otherwise", - "name": "allowuserviewalldomainaccounts", - "type": "boolean" - }, - { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", - "type": "boolean" - }, - { - "description": "time interval (in seconds) to reset api count", - "name": "apilimitinterval", - "type": "integer" - }, - { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", - "type": "boolean" - }, - { - "description": "default page size in the UI for various views, value set in the configurations", - "name": "defaultuipagesize", - "type": "long" - }, - { - "description": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", - "type": "integer" - }, - {}, - { - "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 region supports elastic load balancer on basic zones", - "name": "supportELB", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "true if regular user is allowed to create projects", - "name": "allowusercreateprojects", - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", - "type": "boolean" - }, - { - "description": "true if stats are collected only for user instances, false if system instance stats are also collected", - "name": "instancesstatsuseronly", - "type": "boolean" - }, - { - "description": "version of the cloud stack", - "name": "cloudstackversion", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", - "type": "boolean" - }, - { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", - "type": "boolean" - }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "true if stats are retained for instance disks otherwise false", - "name": "instancesdisksstatsretentionenabled", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the retention time for Instances disks stats", - "name": "instancesdisksstatsretentiontime", - "type": "integer" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "true if user and domain admins can set templates to be shared, false otherwise", - "name": "userpublictemplateenabled", - "type": "boolean" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the retention time for Instances stats", - "name": "instancesstatsretentiontime", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "Display name for custom hypervisor", - "name": "customhypervisordisplayname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Release dedication of zone", - "isasync": true, - "name": "releaseDedicatedZone", - "params": [ - { - "description": "the ID of the Zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the 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": "Updates traffic type of a physical network", - "isasync": true, - "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, + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, + {}, { - "description": "traffic type id", - "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", - "required": true, - "type": "uuid" - }, - { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "length": 255, - "name": "xennetworklabel", - "required": false, + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "length": 255, - "name": "ovm3networklabel", - "required": false, + "description": "OS name of the vm", + "name": "osdisplayname", "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" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "length": 255, - "name": "vmwarenetworklabel", - "required": false, + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" - } - ], - "related": "addTrafficType", - "response": [ + }, + {}, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, - {}, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "id of the network provider", - "name": "id", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "the project name of the vm", + "name": "project", "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 network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "List Conditions for VM auto scaling", - "isasync": false, - "name": "listConditions", - "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the policy", - "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "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": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "Counter-id of the condition.", - "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "ID of the Condition.", - "length": 255, - "name": "id", - "related": "createCondition,listConditions", - "required": false, - "type": "uuid" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - } - ], - "related": "createCondition", - "response": [ - { - "description": "zone id of counter", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain id of the Condition owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the Name of the Counter.", - "name": "countername", - "type": "string" - }, - {}, - { - "description": "the id of the Condition", - "name": "id", - "type": "string" - }, - { - "description": "the owner of the Condition.", - "name": "account", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the Id of the Counter.", - "name": "counterid", - "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "Threshold Value for the counter.", - "name": "threshold", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", - "type": "string" - }, - { - "description": "the domain name of the owner.", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" - }, - { - "description": "the project id of the Condition.", - "name": "projectid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Updates a network serviceProvider of a physical network", - "isasync": true, - "name": "updateNetworkServiceProvider", - "params": [ - { - "description": "Enabled/Disabled/Shutdown the physical network service provider", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "the list of services to be enabled for this physical network service provider", - "length": 255, - "name": "servicelist", - "required": false, - "type": "list" - }, - { - "description": "network service provider id", - "length": 255, - "name": "id", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,updateNetworkServiceProvider,listTrafficTypes", - "required": true, - "type": "uuid" - } - ], - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the provider name", + "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - {}, - { - "description": "uuid of the network provider", - "name": "id", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists Management Server metrics", - "isasync": false, - "name": "listManagementServersMetrics", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the id of the management server", - "length": 255, - "name": "id", - "related": "listManagementServers", - "required": false, - "type": "uuid" - }, - { - "description": "include system level stats", - "length": 255, - "name": "system", - "related": "listManagementServersMetrics", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the management server", - "length": 255, - "name": "name", - "required": false, + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" }, { - "description": "Total system memory", - "name": "systemmemorytotal", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the version of the management server", - "name": "version", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the log files and their usage on disk", - "name": "loginfo", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the management server", - "name": "name", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "description": "the ID of the 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 time these statistics were collected", - "name": "collectiontime", - "type": "date" - }, - { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" - }, - { - "description": "the IP Address for this Management Server", - "name": "serviceip", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the load averages for 1 5 and 15 minutes", - "name": "systemloadaverages", - "type": "double[]" - }, - { - "description": "the number of client sessions active on this Management Server", - "name": "sessions", - "type": "long" - }, - { - "description": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" - }, - { - "description": "the ID of the management server", - "name": "id", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "The number of daemon threads", - "name": "threadsdaemoncount", - "type": "integer" - }, - { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", - "type": "integer" - }, - { - "description": "the current cpu load", - "name": "cpuload", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the amount of memory used by this Management Server", - "name": "heapmemoryused", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "The number of blocked threads", - "name": "threadsblockedcount", - "type": "integer" - }, - { - "description": "The number of waiting threads", - "name": "threadswaitingcount", - "type": "integer" - }, - { - "description": "Free system memory", - "name": "systemmemoryfree", - "type": "string" - }, - { - "description": "the number of processors available to the JVM", - "name": "availableprocessors", - "type": "integer" - }, - { - "description": "The number of terminated threads", - "name": "threadsteminatedcount", - "type": "integer" - }, - {}, - { - "description": "The number of threads", - "name": "threadstotalcount", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the system is running against a local database", - "name": "dbislocal", - "type": "boolean" - }, - { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", + "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": "the system load for user, and system processes and the system idle cycles", - "name": "systemcycleusage", - "type": "long[]" - }, - { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", - "type": "string" - }, - { - "description": "the number of agents this Management Server is responsible for", - "name": "agentcount", - "type": "integer" - }, - { - "description": "Amount of memory used", - "name": "systemmemoryused", - "type": "string" - }, - { - "description": "Virtual size of the fully loaded process", - "name": "systemmemoryvirtualsize", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the system has a usage server running locally", - "name": "usageislocal", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the amount of memory allocated to this Management Server", - "name": "heapmemorytotal", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, - {} - ], - "since": "4.17.0" - }, - { - "description": "Removes a virtual machine or a list of virtual machines from a load balancer rule.", - "isasync": true, - "name": "removeFromLoadBalancerRule", - "params": [ - { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", - "length": 255, - "name": "vmidipmap", - "required": false, - "since": "4.4", - "type": "map" - }, - { - "description": "the 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,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "list" - }, - { - "description": "The ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Lists vm groups", - "isasync": false, - "name": "listInstanceGroups", - "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. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "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 resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "list instance groups by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "list instance groups by ID", - "length": 255, - "name": "id", - "related": "createInstanceGroup,listInstanceGroups,updateInstanceGroup", - "required": false, - "type": "uuid" - } - ], - "related": "createInstanceGroup,updateInstanceGroup", - "response": [ { - "description": "the domain ID of the instance group", + "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", "type": "string" }, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the instance group", - "name": "id", - "type": "string" - }, - { - "description": "the account owning the instance group", - "name": "account", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the project ID of the instance group", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { @@ -34772,172 +33709,145 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the name of the instance group", - "name": "name", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "migrates data objects from one secondary storage to destination image store(s)", - "isasync": true, - "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", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" - }, - { - "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", - "length": 255, - "name": "migrationtype", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the UUID of the latest async job acting on 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": "Response message from migration of secondary storage data objects", - "name": "message", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "Type of migration requested for", - "name": "migrationtype", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, - {} - ], - "since": "4.15.0" - }, - { - "description": "Creates a static route", - "isasync": true, - "name": "createStaticRoute", - "params": [ { - "description": "static route cidr", - "length": 255, - "name": "cidr", - "required": true, + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the gateway id we are creating static route for", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": true, - "type": "uuid" - } - ], - "related": "listStaticRoutes", - "response": [ - { - "description": "the project name of the static route", - "name": "project", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the state of the static route", + "description": "the state of the virtual machine", "name": "state", "type": "string" }, { - "description": "static route CIDR", - "name": "cidr", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the project id of the static route", - "name": "projectid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the account associated with the static route", - "name": "account", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the domain associated with the static route", - "name": "domain", - "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": "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "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 domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the ID of static route", - "name": "id", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the list of resource tags associated with static route", + "description": "the list of resource tags associated", "name": "tags", "response": [ { @@ -34946,38 +33856,38 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -34986,622 +33896,737 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], - "type": "list" - }, - {} - ] - }, - { - "description": "Destroys a Volume.", - "isasync": true, - "name": "destroyVolume", - "params": [ - { - "description": "If true is passed, the volume is expunged immediately. False by default.", - "length": 255, - "name": "expunge", - "required": false, - "since": "4.6.0", - "type": "boolean" - }, - { - "description": "The ID of the volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,destroyVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": true, - "type": "uuid" - } - ], - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "response": [ - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" - }, - {}, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "pod id of the volume", - "name": "podid", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", - "type": "string" + "type": "set" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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 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": "tag key name", - "name": "key", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the 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", + "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": "id of the resource", + "name": "resourceid", + "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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the project name where tag belongs to", + "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" + }, + { + "description": "the list of 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 id of the security group rule", + "name": "ruleid", + "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 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 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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "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 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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "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 display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" - }, + } + ] + }, + { + "description": "Lists Brocade VCS Switches", + "isasync": false, + "name": "listBrocadeVcsDevices", + "params": [ { - "description": "the account associated with the disk volume", - "name": "account", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "Brocade VCS switch ID", + "length": 255, + "name": "vcsdeviceid", + "related": "listBrocadeVcsDevices", + "required": false, + "type": "uuid" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the physical Network to which this Brocade VCS belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the principal switch Ip address", + "name": "hostname", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "device name", + "name": "brocadedevicename", "type": "string" }, + {}, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", "type": "string" }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, {} - ], - "since": "4.14.0" + ] }, { - "description": "Adds traffic type to a physical network", - "isasync": true, - "name": "addTrafficType", + "description": "link an existing cloudstack domain to group or OU in ldap", + "isasync": false, + "name": "linkDomainToLdap", "params": [ { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "length": 255, - "name": "vmwarenetworklabel", - "required": false, - "type": "string" - }, - { - "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 VLAN id to be used for Management traffic by VMware host", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "vlan", + "name": "name", "required": false, "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "description": "domain admin username in LDAP ", "length": 255, - "name": "ovm3networklabel", + "name": "admin", "required": false, "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "description": "name of the group or OU in LDAP", "length": 255, - "name": "xennetworklabel", + "name": "ldapdomain", "required": false, "type": "string" }, { - "description": "Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.", + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", "length": 255, - "name": "isolationmethod", - "required": false, - "type": "string" + "name": "accounttype", + "required": true, + "type": "integer" }, { - "description": "the trafficType to be added to the physical network", + "description": "The id of the domain which has to be linked to LDAP.", "length": 255, - "name": "traffictype", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "description": "type of the ldap name. GROUP or OU", "length": 255, - "name": "kvmnetworklabel", - "required": false, + "name": "type", + "required": true, "type": "string" } ], - "related": "", + "related": "linkAccountToLdap", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", - "name": "vmwarenetworklabel", - "type": "string" + "description": "Type of the account to auto import", + "name": "accounttype", + "type": "int" }, { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", "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 network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", - "name": "ovm3networklabel", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "id of the network provider", - "name": "id", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", - "name": "xennetworklabel", + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", "type": "string" - }, - {} + } ], - "since": "3.0.0" + "since": "4.6.0" }, { - "description": "Deletes a Private gateway", - "isasync": true, - "name": "deletePrivateGateway", + "description": "Setup the 2FA for the user.", + "isasync": false, + "name": "setupUserTwoFactorAuthentication", "params": [ { - "description": "the ID of the private gateway", + "description": "optional: the id of the user for which 2FA has to be disabled", "length": 255, - "name": "id", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": true, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, "type": "uuid" + }, + { + "description": "two factor authentication code", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "Enabled by default, provide false to disable 2FA", + "length": 255, + "name": "enable", + "required": false, + "type": "boolean" } ], + "related": "", "response": [ - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the account ID of the user", + "name": "accountid", "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 user ID", + "name": "id", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "secret code that needs to be registered with authenticator", + "name": "secretcode", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" } - ] + ], + "since": "4.18.0" }, { - "description": "Lists the secondary storage selectors and their rules.", + "description": "Lists site to site vpn customer gateways", "isasync": false, - "name": "listSecondaryStorageSelectors", + "name": "listVpnCustomerGateways", "params": [ { - "description": "Show removed heuristics.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "showremoved", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "type", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "id of the customer gateway", + "length": 255, + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, @@ -35622,172 +34647,174 @@ "name": "page", "required": false, "type": "integer" - }, - { - "description": "The zone ID to be used in the search filter.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" } ], - "related": "createSecondaryStorageSelector,updateSecondaryStorageSelector,removeSecondaryStorageSelector", + "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "response": [ { - "description": "Name of the heuristic.", - "name": "name", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the owner", + "name": "account", + "type": "string" }, {}, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" + "description": "the vpn gateway ID", + "name": "id", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" + }, + {}, + { + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "the 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": "Description of the heuristic.", - "name": "description", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" - } - ], - "since": "4.19.0" - }, - { - "description": "List all virtual machine instances that are assigned to a load balancer rule.", - "isasync": false, - "name": "listLoadBalancerRuleInstances", - "params": [ + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, { - "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", - "length": 255, - "name": "applied", - "required": false, + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "true if load balancer rule VM IP information to be included; default is false", - "length": 255, - "name": "lbvmips", - "required": false, - "type": "boolean" + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "listLoadBalancerRuleInstances", - "response": [ - {}, + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, { - "description": "the user vm set for lb rule", - "name": "loadbalancerruleinstance", - "type": "uservmresponse" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, - {}, { - "description": "IP addresses of the vm set of lb rule", - "name": "lbvmipaddresses", - "type": "list" + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" + }, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" } ] }, { - "description": "Removes a condition for VM auto scaling", + "description": "Deletes a Kubernetes cluster", "isasync": true, - "name": "deleteCondition", + "name": "deleteKubernetesCluster", "params": [ { - "description": "the ID of the condition.", + "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", + "length": 255, + "name": "expunge", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "the ID of the Kubernetes cluster", "length": 255, "name": "id", - "related": "createCondition", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "required": true, "type": "uuid" } ], "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -35797,394 +34824,707 @@ }, {}, { - "description": "true if 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": "Updates a domain with a new name", + "description": "Lists Webhooks", "isasync": false, - "name": "updateDomain", + "name": "listWebhooks", "params": [ { - "description": "updates domain with this name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", + "description": "The name of the Webhook", "length": 255, - "name": "networkdomain", + "name": "name", "required": false, "type": "string" }, { - "description": "ID of domain to update", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "The ID of the Webhook", "length": 255, "name": "id", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain", - "required": true, + "related": "createWebhook,listWebhooks,listWebhookDeliveries", + "required": false, "type": "uuid" - } - ], - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "response": [ + }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "The scope of the Webhook", + "length": 255, + "name": "scope", + "required": false, "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "The state of the Webhook", + "length": 255, + "name": "state", + "required": false, + "type": "string" + } + ], + "related": "createWebhook,listWebhookDeliveries", + "response": [ + { + "description": "The state of the Webhook", + "name": "state", + "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", + "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The account associated with the Webhook", + "name": "account", + "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "The scope of the Webhook", + "name": "scope", + "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 total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", + "type": "string" }, + {}, + {} + ], + "since": "4.20.0" + }, + { + "description": "Creates a global load balancer rule", + "isasync": true, + "name": "createGlobalLoadBalancerRule", + "params": [ { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "domain name for the GSLB service.", + "length": 255, + "name": "gslbdomainname", + "required": true, "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "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": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "name of the load balancer rule", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "length": 255, + "name": "gslbstickysessionmethodname", + "required": false, + "type": "string" }, - {}, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the domain ID associated with the load balancer", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "GSLB service type (tcp, udp, http)", + "length": 255, + "name": "gslbservicetype", + "required": true, "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", + "required": false, "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "region where the global load balancer is going to be created.", + "length": 255, + "name": "regionid", + "related": "addRegion,updateRegion,listRegions", + "required": true, + "type": "integer" + } + ], + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "response": [ + { + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, {}, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", + "response": [ + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "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 id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "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 project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "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": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + } + ] + }, + { + "description": " delete a netscaler load balancer device", + "isasync": true, + "name": "deleteNetscalerLoadBalancer", + "params": [ { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Updates a physical network", - "isasync": true, - "name": "updatePhysicalNetwork", + "description": "List resource tag(s)", + "isasync": false, + "name": "listTags", "params": [ { - "description": "the speed for the physical network[1G/10G]", + "description": "", "length": 255, - "name": "networkspeed", + "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 by key", + "length": 255, + "name": "key", "required": false, "type": "string" }, { - "description": "Enabled/Disabled", + "description": "list by resource id", "length": 255, - "name": "state", + "name": "resourceid", "required": false, "type": "string" }, { - "description": "Tag the physical network", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "tags", + "name": "listall", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "the VLAN for the physical network", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "vlan", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list by customer name", + "length": 255, + "name": "customer", "required": false, "type": "string" }, { - "description": "physical network id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createPhysicalNetwork,updatePhysicalNetwork", - "required": true, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, "type": "uuid" - } - ], - "related": "createPhysicalNetwork", - "response": [ + }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "list by value", + "length": 255, + "name": "value", + "required": false, "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list by resource type", + "length": 255, + "name": "resourcetype", + "required": false, "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "listResourceDetails", + "response": [ + {}, + { + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -36193,120 +35533,184 @@ "type": "integer" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, + {}, { - "description": "state of the physical network", - "name": "state", + "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" + } ], - "since": "3.0.0" + "since": "4.0.0" }, { - "description": "Disables an AutoScale Vm Group", - "isasync": true, - "name": "disableAutoScaleVmGroup", + "description": "List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster.", + "isasync": false, + "name": "listAffectedVmsForStorageScopeChange", "params": [ { - "description": "the ID of the autoscale group", + "description": "", "length": 255, - "name": "id", - "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the Id of the cluster the scope of the storage pool is being changed to", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the Id of the storage pool on which change scope operation is being done", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "related": "", "response": [ { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the ID of the VM", + "name": "id", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the cluster ID for the VM", + "name": "clusterid", + "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the hostname for the VM", + "name": "hostname", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the cluster name for the VM", + "name": "clustername", + "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the name of the VM", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the host ID for the VM", + "name": "hostid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the type of VM", + "name": "type", "type": "string" }, + {} + ], + "since": "4.19.1" + }, + { + "description": "Create a virtual router element.", + "isasync": true, + "name": "createVirtualRouterElement", + "params": [ { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the network service provider ID of the virtual router element", + "length": 255, + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "required": true, + "type": "uuid" }, { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, + "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", + "length": 255, + "name": "providertype", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "required": false, + "type": "uuid" + } + ], + "related": "configureVirtualRouterElement,listVirtualRouterElements", + "response": [ + {}, { - "description": "the account owning the vm group", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, + { + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" }, {}, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the domain associated with the provider", + "name": "domain", "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 physical network service provider id of the provider", + "name": "nspid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -36314,178 +35718,289 @@ "type": "integer" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the account associated with the provider", + "name": "account", "type": "string" - }, + } + ] + }, + { + "description": "Creates a VPC", + "isasync": true, + "name": "createVPC", + "params": [ { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the AS Number of the VPC tiers", + "length": 255, + "name": "asnumber", + "required": false, + "since": "4.20.0", + "type": "long" }, { - "description": "is group for display to the regular user", + "description": "an optional field, whether to the display the vpc to the end user or not", + "length": 255, "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" + "description": "MTU to be configured on the network VR's public facing interfaces", + "length": 255, + "name": "publicmtu", + "required": false, + "since": "4.18.0", + "type": "integer" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.", + "length": 255, + "name": "cidrsize", + "required": false, + "since": "4.20.0", + "type": "integer" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the first IPv4 DNS for the VPC", + "length": 255, + "name": "dns1", + "required": false, + "since": "4.18.0", "type": "string" }, - {}, { - "description": "the project name of the vm group", - "name": "project", + "description": "IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "length": 255, + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "length": 255, + "name": "cidr", + "required": false, "type": "string" - } - ] - }, - { - "description": "Creates a snapshot policy for the account.", - "isasync": false, - "name": "createSnapshotPolicy", - "params": [ + }, { - "description": "time the snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)", + "description": "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": "schedule", - "required": true, - "type": "string" + "name": "start", + "required": false, + "since": "4.3", + "type": "boolean" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "description": "the ID of the availability zone", "length": 255, - "name": "intervaltype", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "an optional field, whether to the display the policy to the end user or not", + "description": "the first IPv6 DNS for the VPC", "length": 255, - "name": "fordisplay", + "name": "ip6dns1", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "the ID of the disk volume", + "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": "volumeid", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": true, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, "type": "uuid" }, { - "description": "A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present.", + "description": "Ids of the Bgp Peer for the VPC", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", "required": false, + "since": "4.20.0", "type": "list" }, { - "description": "Map of tags (key/value pairs)", + "description": "the account associated with the VPC. Must be used with the domainId parameter.", "length": 255, - "name": "tags", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "the name of the VPC", "length": 255, - "name": "timezone", + "name": "name", "required": true, "type": "string" }, { - "description": "maximum number of snapshots to retain", + "description": "the second IPv4 DNS for the VPC", "length": 255, - "name": "maxsnaps", - "required": true, - "type": "integer" - } - ], - "related": "updateSnapshotPolicy", - "response": [ - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" + "name": "dns2", + "required": false, + "since": "4.18.0", + "type": "string" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "The display text of the VPC, defaults to its 'name'.", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" }, - {}, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", + "description": "the second IPv6 DNS for the VPC", + "length": 255, + "name": "ip6dns2", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "VPC network domain. All networks inside the VPC will belong to this domain", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" + }, + { + "description": "the ID of the VPC offering", + "length": 255, + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "create VPC for the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" + } + ], + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "response": [ + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "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 ID of the snapshot policy", - "name": "id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, + { + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { @@ -36494,13 +36009,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -36509,8 +36019,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -36519,8 +36029,18 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -36529,365 +36049,250 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "set" - }, - { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "type": "list" }, - {} - ] - }, - { - "description": "create Tungsten-Fabric management network", - "isasync": false, - "name": "createTungstenFabricManagementNetwork", - "params": [ - { - "description": "the ID of pod", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, - "type": "uuid" - } - ], - "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "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": "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": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Disables HA for a zone", - "isasync": true, - "name": "disableHAForZone", - "params": [ - { - "description": "ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if VPC is region level", + "name": "regionlevelvpc", "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", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.11" - }, - { - "description": "list Tungsten-Fabric firewall rule", - "isasync": false, - "name": "listTungstenFabricFirewallRule", - "params": [ { - "description": "the uuid of Tungsten-Fabric firewall rule", - "length": 255, - "name": "firewallruleuuid", - "required": false, - "type": "string" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", - "required": false, + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule tag type", - "name": "tagtype", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, - {}, { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", - "type": "string" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", - "type": "string" + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" }, { - "description": "Tungsten-Fabric firewall rule destination network", - "name": "destnetwork", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" } ] }, { - "description": "Adds an API permission to a role", - "isasync": false, - "name": "createRolePermission", + "description": "Removes detail for the Resource.", + "isasync": true, + "name": "removeResourceDetail", "params": [ { - "description": "The rule permission, allow or deny. Default: deny.", - "length": 255, - "name": "permission", - "required": true, - "type": "string" - }, - { - "description": "The description of the role permission", + "description": "Delete details matching key/value pairs", "length": 255, - "name": "description", + "name": "key", "required": false, "type": "string" }, { - "description": "ID of the role", + "description": "Delete detail by resource type", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "resourcetype", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The API name or wildcard rule such as list*", + "description": "Delete details for resource id", "length": 255, - "name": "rule", + "name": "resourceid", "required": true, "type": "string" } ], - "related": "listRolePermissions", "response": [ + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the role permission", - "name": "id", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", - "type": "string" - }, - {}, - { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" - }, - { - "description": "the description of the role permission", - "name": "description", - "type": "string" - }, - {} - ], - "since": "4.9.0" + } + ] }, { - "description": "List system virtual machines.", + "description": "Lists all supported OS types for this cloud.", "isasync": false, - "name": "listSystemVms", + "name": "listOsTypes", "params": [ { - "description": "the state of the system VM", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "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 Zone ID of the system VM", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the system VM", + "description": "", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -36897,451 +36302,227 @@ "type": "integer" }, { - "description": "the Pod ID of the system VM", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.18.1", + "type": "boolean" }, { - "description": "the name of the system VM", + "description": "list by Os Category id", "length": 255, - "name": "name", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", + "description": "list os by description", "length": 255, - "name": "systemvmtype", + "name": "description", "required": false, + "since": "3.0.1", "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the host ID of the system VM", + "description": "list by Os type Id", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "id", + "related": "listOsTypes,addGuestOs", "required": false, "type": "uuid" } ], - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "related": "addGuestOs", "response": [ { - "description": "the state of the system VM", - "name": "state", - "type": "string" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "the name of the system VM", - "name": "name", - "type": "string" - }, - { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" - }, - { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" - }, - { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" - }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" - }, - { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" - }, - { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" - }, - { - "description": "the Pod name for the system VM", - "name": "podname", - "type": "string" - }, - { - "description": "the agent state of the system VM", - "name": "agentstate", - "type": "string" - }, - { - "description": "the systemvm agent version", - "name": "version", - "type": "string" - }, - { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" - }, - {}, - { - "description": "the gateway for the system VM", - "name": "gateway", - "type": "string" - }, - { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the ID of the OS type", + "name": "id", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "is the guest OS visible for the users", + "name": "fordisplay", "type": "boolean" }, - { - "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 private IP address for the system VM", - "name": "privateip", - "type": "string" - }, - { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", - "type": "string" - }, - { - "description": "the system VM type", - "name": "systemvmtype", - "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" - }, - { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", - "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": "the ID of the system VM", - "name": "id", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the OS type", + "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 for the system VM", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" - }, - { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" - }, - { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" - }, - { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" } ] }, { - "description": "Creates a project", + "description": "Removes a Guest OS from listing.", "isasync": true, - "name": "createProject", + "name": "removeGuestOs", "params": [ { - "description": "domain ID of the account owning a project", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "account who will be Admin for the project", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "name of the project", + "description": "ID of the guest OS", "length": 255, - "name": "name", + "name": "id", + "related": "addGuestOs", "required": true, - "type": "string" - }, - { - "description": "The display text of the project, defaults to the 'name´.", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "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": "ID of the account owning a project", - "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, "type": "uuid" } ], - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the id of the project", - "name": "id", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) 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 memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.4.0" + }, + { + "description": "Detaches any ISO file (if any) currently attached to a virtual machine.", + "isasync": true, + "name": "detachIso", + "params": [ { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" + "description": "If true, ejects the ISO before detaching on VMware. Default: false", + "length": 255, + "name": "forced", + "required": false, + "since": "4.15.1", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" - }, + "description": "The ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "response": [ { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the name of the project", - "name": "name", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the list of resource tags associated with vm", + "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -37350,23 +36531,23 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -37375,738 +36556,1230 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, + {}, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, {}, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the ID of the 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 project", - "name": "state", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "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 name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - } - ], - "since": "3.0.0" - }, - { - "description": "Assigns a certificate to a load balancer rule", - "isasync": true, - "name": "assignCertToLoadBalancer", - "params": [ + "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 load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", - "required": true, - "type": "uuid" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the certificate", - "length": 255, - "name": "certid", - "related": "uploadSslCert", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "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", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" - } - ] - }, - { - "description": "Adds a Cisco Vnmc Controller", - "isasync": false, - "name": "addCiscoVnmcResource", - "params": [ + }, { - "description": "Credentials to access the Cisco VNMC Controller API", - "length": 255, - "name": "username", - "required": true, + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "Hostname or ip address of the Cisco VNMC Controller.", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "Credentials to access the Cisco VNMC Controller API", - "length": 255, - "name": "password", - "required": true, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" - } - ], - "related": "listCiscoVnmcResources", - "response": [ + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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" + } + ], + "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 description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the 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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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" + } + ], + "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 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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, - {}, - {}, - {} - ] - }, - { - "description": "Detaches a disk volume from a virtual machine.", - "isasync": true, - "name": "detachVolume", - "params": [ { - "description": "the ID of the virtual machine where the volume is detached from", - "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the device ID on the virtual machine where volume is detached from", - "length": 255, - "name": "deviceid", - "required": false, + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the ID of the disk volume", - "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,detachVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": false, - "type": "uuid" - } - ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "response": [ + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "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", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the UUID of the latest async job acting on 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 pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "set" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { "description": "the VM's disk write in KiB", "name": "diskkbswrite", "type": "long" }, + {}, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "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": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "User VM type", + "name": "vmtype", "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", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" - }, - { - "description": "the path of the volume", - "name": "path", + } + ] + }, + { + "description": " delete a Palo Alto firewall device", + "isasync": true, + "name": "deletePaloAltoFirewall", + "params": [ + { + "description": "Palo Alto firewall device ID", + "length": 255, + "name": "fwdeviceid", + "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", + "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 boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Executes a Webhook delivery", + "isasync": false, + "name": "executeWebhookDelivery", + "params": [ + { + "description": "Payload of the Webhook delivery", + "length": 255, + "name": "payload", + "required": false, "type": "string" }, - {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "If set to true then SSL verification will be done for the Webhook delivery otherwise not", + "length": 255, + "name": "sslverification", + "required": false, + "type": "boolean" + }, + { + "description": "Payload URL of the Webhook delivery", + "length": 255, + "name": "payloadurl", + "required": false, "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "Secret key of the Webhook delivery", + "length": 255, + "name": "secretkey", + "required": false, "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "The ID of the Webhook delivery for redelivery", + "length": 255, + "name": "id", + "related": "executeWebhookDelivery", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the Webhook", + "length": 255, + "name": "webhookid", + "related": "createWebhook,listWebhookDeliveries", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "The start time of the Webhook delivery", + "name": "startdate", + "type": "date" + }, + { + "description": "The ID of the Webhook delivery", + "name": "id", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "The ID of the management server which executed delivery", + "name": "managementserverid", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "The name of the management server which executed delivery", + "name": "managementservername", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "The payload of the webhook delivery", + "name": "payload", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", + "description": "The end time of the Webhook delivery", + "name": "enddate", "type": "date" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "Whether Webhook delivery succeeded or not", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The ID of the Webhook", + "name": "webhookid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "The ID of the event", + "name": "eventid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" + "description": "The name of the Webhook", + "name": "webhookname", + "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "The response of the webhook delivery", + "name": "response", "type": "string" }, + {}, { - "description": "the disk utilization", - "name": "utilization", + "description": "The type of the event", + "name": "eventtype", "type": "string" }, + {}, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "The headers of the webhook delivery", + "name": "headers", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Replaces ACL associated with a network or private gateway", - "isasync": true, - "name": "replaceNetworkACLList", + "description": "Deletes a Pod.", + "isasync": false, + "name": "deletePod", "params": [ { - "description": "the ID of the network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the private gateway", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the network ACL", + "description": "the ID of the Pod", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "id", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": true, "type": "uuid" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the current status 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": "list Tungsten-Fabric address group", + "description": "Lists Tungsten-Fabric providers", "isasync": false, - "name": "listTungstenFabricAddressGroup", + "name": "listTungstenFabricProviders", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric address group", + "description": "List by keyword", "length": 255, - "name": "addressgroupuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", @@ -38119,26 +37792,34 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], - "related": "createTungstenFabricAddressGroup", + "related": "createTungstenFabricProvider", "response": [ + { + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric address group ip prefix length", - "name": "ipprefixlen", - "type": "int" + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "Tungsten-Fabric provider zone id", @@ -38146,522 +37827,553 @@ "type": "long" }, { - "description": "Tungsten-Fabric address group uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider name", + "name": "name", "type": "string" }, {}, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric address group name", + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", + "type": "string" + } + ] + }, + { + "description": "Lists all DeploymentPlanners available.", + "isasync": false, + "name": "listDeploymentPlanners", + "params": [ + { + "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": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Deployment Planner name", "name": "name", "type": "string" }, {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", - "type": "string" } ] }, { - "description": "Marks a default zone for this account", - "isasync": true, - "name": "markDefaultZoneForAccount", + "description": "Deletes a cluster.", + "isasync": false, + "name": "deleteCluster", "params": [ { - "description": "The Zone ID with which the account is to be marked.", + "description": "the cluster ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "Marks the account that belongs to the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "Name of the account that is to be marked.", + "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": "Prepares a host for maintenance.", + "isasync": true, + "name": "prepareHostForMaintenance", + "params": [ + { + "description": "the host ID", "length": 255, - "name": "account", - "related": "createAccount,disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the name of the account", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" + "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": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, + {}, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "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 timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "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 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 ID", - "name": "id", - "type": "string" - } - ], - "type": "list" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the name of the host", + "name": "name", "type": "string" }, - {}, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "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 total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "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 bytes", + "name": "memoryallocatedbytes", "type": "long" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" } - ], - "since": "4.0" + ] }, { - "description": "Enables out-of-band management for a zone", - "isasync": true, - "name": "enableOutOfBandManagementForZone", + "description": "Removes specified region", + "isasync": false, + "name": "removeRegion", "params": [ { - "description": "the ID of the zone", + "description": "ID of the region to delete", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", "required": true, - "type": "uuid" + "type": "integer" } ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,issueOutOfBandManagementPowerAction", "response": [ + {}, { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -38669,362 +38381,205 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the out-of-band management interface address", - "name": "address", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - }, - { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" - }, + } + ] + }, + { + "description": "Get Volume's iSCSI Name", + "isasync": false, + "name": "getVolumeiScsiName", + "params": [ { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "CloudStack Volume UUID", + "length": 255, + "name": "volumeid", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ + {}, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "Volume iSCSI Name", + "name": "volumeiScsiName", "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" } - ], - "since": "4.9.0" + ] }, { - "description": "Lists LDAP Users according to the specifications from the user request.", - "isasync": false, - "name": "listLdapUsers", + "description": "Updates an existing autoscale vm group.", + "isasync": true, + "name": "updateAutoScaleVmGroup", "params": [ { - "description": "List by keyword", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "Determines what type of filter is applied on the list of users returned from LDAP.\n\tvalid values are\n\t'NoFilter'\t no filtering is done,\n\t'LocalDomain'\tusers already in the current or requested domain will be filtered out of the result list,\n\t'AnyDomain'\tusers that already exist anywhere in cloudstack will be filtered out, and\n\t'PotentialImport'\tall users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "userfilter", + "name": "customid", "required": false, - "since": "4.13", + "since": "4.4", "type": "string" }, { - "description": "Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter", + "description": "list of scaleup autoscale policies", "length": 255, - "name": "listtype", + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "type": "string" + "type": "list" }, { - "description": "linked domain", + "description": "the ID of the autoscale group", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "required": true, + "type": "uuid" + }, { - "description": "", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "page", + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": false, - "type": "integer" + "type": "list" }, { - "description": "", + "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": "pagesize", + "name": "minmembers", "required": false, "type": "integer" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The user's domain", - "name": "domain", - "type": "string" - }, - {}, - { - "description": "The user's email", - "name": "email", - "type": "string" - }, - { - "description": "The user's username", - "name": "username", - "type": "string" - }, - { - "description": "The user's lastname", - "name": "lastname", - "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 firstname", - "name": "firstname", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Revokes certificate using configured CA plugin", - "isasync": true, - "name": "revokeCertificate", - "params": [ - { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "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": "provider", + "name": "maxmembers", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The certificate CN", + "description": "the frequency in which the performance counters to be collected", "length": 255, - "name": "cn", + "name": "interval", "required": false, - "type": "string" - }, - { - "description": "The certificate serial number, as a hex value", - "length": 255, - "name": "serial", - "required": true, - "type": "string" - } - ], - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {} - ], - "since": "4.11.0" - }, - { - "description": "Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.", - "isasync": false, - "name": "changeServiceForSystemVm", - "params": [ - { - "description": "the service offering ID to apply to the system vm", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "The ID of the system vm", - "length": 255, - "name": "id", - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": true, - "type": "uuid" - }, - { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "map" + "since": "4.18.0", + "type": "string" } ], - "related": "migrateSystemVm,startSystemVm", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "response": [ { - "description": "the hostname for the system VM", - "name": "hostname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "the public IP address for the system VM", + "description": "the public ip address", "name": "publicip", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" - }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the host ID for the system VM", - "name": "hostid", - "type": "string" - }, - { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" - }, - { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "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": "public vlan range", - "name": "publicvlan", + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", "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 domain ID of the vm group", + "name": "domainid", + "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "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 link local MAC address for the system vm", - "name": "linklocalmacaddress", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { "description": "the current status of the latest async job acting on this object", @@ -39032,332 +38587,378 @@ "type": "integer" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" - }, - { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, - {}, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the autoscale vm group ID", + "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 gateway for the system VM", - "name": "gateway", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" - }, - { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "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": "Update SIOC info", - "isasync": false, - "name": "updateSiocInfo", + "description": "Deletes a snapshot of a disk volume.", + "isasync": true, + "name": "deleteSnapshot", "params": [ { - "description": "Storage Pool ID", + "description": "The ID of the snapshot", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", "required": true, "type": "uuid" }, { - "description": "Shares per GB", - "length": 255, - "name": "sharespergb", - "required": true, - "type": "integer" - }, - { - "description": "Zone ID", + "description": "The ID of the zone for the snapshot", "length": 255, "name": "zoneid", "related": "createZone,updateZone,listZones,listZones", - "required": true, + "required": false, + "since": "4.19.0", "type": "uuid" - }, - { - "description": "Notify if IOPS above this value", - "length": 255, - "name": "iopsnotifythreshold", - "required": true, - "type": "integer" - }, - { - "description": "Limit IOPS per GB", - "length": 255, - "name": "limitiopspergb", - "required": true, - "type": "integer" } ], - "related": "", "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The return message from the operation ('Success' if successful)", - "name": "msg", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - } - ], - "since": "4.11.0" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ] }, { - "description": "Create VM Schedule", + "description": "List the virtual machines owned by the account.", "isasync": false, - "name": "createVMSchedule", + "name": "listVirtualMachines", "params": [ { - "description": "ID of the VM for which schedule is to be defined", + "description": "list vms by affinity group", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", + "required": false, "type": "uuid" }, { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "schedule", - "required": true, - "type": "string" + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "required": false, + "since": "4.18.0", + "type": "uuid" }, { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", + "description": "", "length": 255, - "name": "enddate", + "name": "page", "required": false, - "type": "date" + "type": "integer" }, { - "description": "Action to take on the VM (start/stop/restart/force_stop/force_reboot).", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "action", - "required": true, - "type": "string" + "name": "tags", + "required": false, + "type": "map" }, { - "description": "start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "startdate", + "name": "retrieveonlyresourcecount", "required": false, - "type": "date" + "type": "boolean" }, { - "description": "Enable VM schedule. Defaults to true", + "description": "list by network id", "length": 255, - "name": "enabled", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "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": "Description of the schedule", + "description": "List by keyword", "length": 255, - "name": "description", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", + "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", "length": 255, - "name": "timezone", - "required": true, - "type": "string" - } - ], - "related": "updateVMSchedule", - "response": [ + "name": "isvnf", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the storage ID where vm's volumes belong to", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" }, { - "description": "Cron formatted VM schedule", - "name": "schedule", - "type": "string" + "description": "list vms by iso", + "length": 255, + "name": "isoid", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "length": 255, + "name": "accumulate", + "required": false, + "since": "4.17.0", + "type": "boolean" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "the IDs of the virtual machines, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": false, + "since": "4.4", + "type": "list" }, { - "description": "VM schedule is enabled", - "name": "enabled", + "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", + "length": 255, + "name": "details", + "required": false, + "type": "list" + }, + { + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "length": 255, + "name": "forvirtualnetwork", + "required": false, "type": "boolean" }, - {}, - {}, { - "description": "Action", - "name": "action", - "type": "action" + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "since": "4.16.0", + "type": "uuid" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "the pod ID", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the ID of VM schedule", - "name": "id", + "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 target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "Description of VM schedule", - "name": "description", + "description": "list vms by ssh keypair name", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "description": "Timezone of the schedule", - "name": "timezone", + "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": "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.19.0" - }, - { - "description": "List the IP forwarding rules", - "isasync": false, - "name": "listIpForwardingRules", - "params": [ + "description": "list vms by vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" + }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the virtual machine", "length": 255, - "name": "account", + "name": "id", + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "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": "the group ID", + "length": 255, + "name": "groupid", + "related": "createInstanceGroup,updateInstanceGroup", + "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": "list the rule belonging to this public IP address", + "description": "the host ID", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "hostid", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "isrecursive", + "name": "userdata", "required": false, + "since": "4.18.0.0", "type": "boolean" }, { - "description": "List by keyword", + "description": "list by the backup offering", "length": 255, - "name": "keyword", + "name": "backupofferingid", + "required": false, + "since": "4.17", + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "Lists all rules applied to the specified VM.", + "description": "the availability zone ID", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, @@ -39369,377 +38970,308 @@ "type": "boolean" }, { - "description": "", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "page", + "name": "displayvm", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the security group ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, + "since": "4.15", "type": "uuid" }, { - "description": "Lists rule with the specified ID.", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,listIpForwardingRules", + "name": "haenable", "required": false, - "type": "uuid" + "since": "4.15", + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "list only resources belonging to the domain specified", "length": 255, "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "", + "description": "list vms by template", "length": 255, - "name": "pagesize", + "name": "templateid", + "related": "prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule", + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the ID of the 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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the 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": "list" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, - {}, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" - } - ] - }, - { - "description": "Creates an instant snapshot of a volume.", - "isasync": true, - "name": "createSnapshot", - "params": [ + }, { - "description": "asynchronous backup if true", - "length": 255, - "name": "asyncbackup", - "required": false, - "type": "boolean" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "Map of tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", - "length": 255, - "name": "locationtype", - "required": false, + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the name of the snapshot", - "length": 255, - "name": "name", - "required": false, + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present.", - "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.19.0", - "type": "list" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "quiesce vm if true", - "length": 255, - "name": "quiescevm", - "required": false, - "type": "boolean" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "The ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": true, - "type": "uuid" - } - ], - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", - "response": [ - { - "description": "ID of the snapshot", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "tag value", - "name": "value", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the affinity group", "name": "domain", "type": "string" } ], "type": "set" }, - {}, { - "description": "the project name of the snapshot", - "name": "project", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, - { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, + {}, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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", @@ -39747,575 +39279,47 @@ "type": "boolean" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" - }, - { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" - }, - {}, - { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" - }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the snapshot", - "name": "name", - "type": "string" - }, - { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", - "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": "name of the disk volume", - "name": "volumename", - "type": "string" - }, - { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", - "type": "string" - }, - { - "description": "ID of the disk volume", - "name": "volumeid", - "type": "string" - } - ] - }, - { - "description": "Deletes a vmsnapshot.", - "isasync": true, - "name": "deleteVMSnapshot", - "params": [ - { - "description": "The ID of the VM snapshot", - "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Lists storage pool metrics", - "isasync": false, - "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 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", - "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 IP address for the storage pool", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" - }, - { - "description": "host ID of the storage pools", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" - }, - { - "description": "the status of the storage pool", - "length": 255, - "name": "status", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "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", - "required": false, - "type": "integer" - }, - { - "description": "the scope 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": "", - "response": [ - { - "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 name of the cluster for the storage pool", - "name": "clustername", - "type": "string" - }, - { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", - "type": "string" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "the name of the storage pool", + "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" - }, - { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", - "type": "boolean" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" - }, - { - "description": "the storage pool type", - "name": "type", - "type": "string" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the 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": "disk size in GiB", - "name": "disksizetotalgb", - "type": "string" - }, - { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - }, - { - "description": "disk size used in GiB", - "name": "disksizeusedgb", - "type": "string" - }, - { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" - }, - { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" - }, - { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", - "type": "boolean" - }, - { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", - "type": "string" - }, - { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" - }, - { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", - "type": "boolean" - }, - { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "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 host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - {}, - { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" - } - ], - "since": "4.9.3" - }, - { - "description": "Unmanage a guest virtual machine.", - "isasync": true, - "name": "unmanageVirtualMachine", - "params": [ - { - "description": "The ID of the virtual machine to unmanage", - "length": 255, - "name": "id", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "details of the unmanage VM operation", + "description": "Vm details in key/value pairs.", "name": "details", - "type": "string" - }, - {}, - { - "description": "result of the unmanage VM operation", - "name": "success", - "type": "boolean" - } - ], - "since": "4.15.0" - }, - { - "description": "Starts a router.", - "isasync": true, - "name": "rebootRouter", - "params": [ - { - "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": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the name of the router", - "name": "name", - "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 link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "type": "map" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the list of nics associated with the router", + "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -40324,43 +39328,38 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { @@ -40369,24 +39368,19 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the type of the nic", + "name": "type", + "type": "string" }, { "description": "true if nic is default, false otherwise", @@ -40399,133 +39393,111 @@ "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the netmask of the nic", + "name": "netmask", "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" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" } ], "type": "set" }, - {}, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, - {}, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -40534,571 +39506,768 @@ "type": "integer" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the first DNS for the router", - "name": "dns1", + "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 service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "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": "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 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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the 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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the name of the security group", + "name": "name", + "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the account owning the security group", + "name": "account", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - } - ] - }, - { - "description": "list the vm nics IP to NIC", - "isasync": false, - "name": "listNics", - "params": [ - { - "description": "the ID of the nic to list IPs", - "length": 255, - "name": "nicid", - "related": "listNics", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "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,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "list nic of the specific vm's network", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "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 keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "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 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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the 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" + }, + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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" + } + ], + "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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, {}, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, {}, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "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 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 gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the 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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "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 account associated with the virtual machine", + "name": "account", "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" } ] }, { - "description": "Create a new keypair and returns the private key", + "description": "Lists all available disk offerings.", "isasync": false, - "name": "createSSHKeyPair", + "name": "listDiskOfferings", "params": [ { - "description": "Name of the keypair", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "an optional account for the ssh key. Must be used with domainId.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "an optional project for the ssh key", + "description": "The ID of a virtual machine. Pass this in if you want to see the suitable disk offering that can be used to create and add a disk to the virtual machine. Suitability is returned with suitableforvirtualmachine flag in the response", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": false, + "since": "4.20.0", "type": "uuid" }, { - "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "description": "list only resources belonging to the domain specified", "length": 255, "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" }, - {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "length": 255, + "name": "state", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "Private key", - "name": "privatekey", - "type": "string" + "description": "The ID of the volume, tags of the volume are used to filter the offerings", + "length": 255, + "name": "volumeid", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "ID of the ssh keypair", - "name": "id", - "type": "string" + "description": "id of zone disk offering is associated with", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "uuid" }, { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "name of the disk offering", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "listed offerings support disk encryption", + "length": 255, + "name": "encrypt", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "Name of the keypair", - "name": "name", + "description": "the storage type of the service offering. Values are local and shared.", + "length": 255, + "name": "storagetype", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the owner of the keypair", - "name": "account", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {}, { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the project name of the keypair owner", - "name": "project", - "type": "string" + "description": "ID of the disk offering", + "length": 255, + "name": "id", + "related": "createDiskOffering,listDiskOfferings", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Creates an instant snapshot of a volume from existing vm snapshot.", - "isasync": true, - "name": "createSnapshotFromVMSnapshot", - "params": [ + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, { - "description": "The ID of the disk volume", + "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": true, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "the name of the snapshot", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "The ID of the VM snapshot", + "description": "", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" } ], - "related": "copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", + "related": "createDiskOffering", "response": [ { - "description": "the project name of the snapshot", - "name": "project", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -41106,987 +40275,669 @@ "type": "integer" }, { - "description": "the domain name of the snapshot's account", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domain", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "unique ID of the disk offering", + "name": "id", "type": "string" }, { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "the storage type for this disk offering", + "name": "storagetype", + "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", + "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": "id of the availability zone", - "name": "zoneid", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", + "type": "boolean" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, - {}, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, + {}, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "name of the disk volume", - "name": "volumename", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", + "description": "additional key/value details tied with this disk offering", + "name": "details", "type": "map" }, + {}, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", - "type": "string" + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "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": "display name of the os on volume", - "name": "osdisplayname", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "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": "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": " the date the snapshot was created", + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" + }, + { + "description": "the date this disk offering was created", "name": "created", "type": "date" }, { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "name of the snapshot", - "name": "name", - "type": "string" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, - {}, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "state of the disk offering", + "name": "state", "type": "string" } - ], - "since": "4.10.0" + ] }, { - "description": "list Tungsten-Fabric service group", + "description": "Deletes a Cisco ASA 1000v appliance", "isasync": false, - "name": "listTungstenFabricServiceGroup", + "name": "deleteCiscoAsa1000vResource", "params": [ { - "description": "the uuid of Tungsten-Fabric service group", + "description": "Cisco ASA 1000v resource ID", "length": 255, - "name": "servicegroupuuid", - "required": false, + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" + } + ] + }, + { + "description": "Upgrades a running CloudManaged Kubernetes cluster", + "isasync": true, + "name": "upgradeKubernetesCluster", + "params": [ + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" }, { - "description": "the ID of zone", + "description": "the ID of the Kubernetes version for upgrade", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "kubernetesversionid", + "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "required": true, "type": "uuid" } ], - "related": "createTungstenFabricServiceGroup", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "Tungsten-Fabric service group protocol", - "name": "protocol", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "Tungsten-Fabric service group end port", - "name": "endport", - "type": "int" + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" }, { - "description": "Tungsten-Fabric service group name", - "name": "name", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric service group uuid", - "name": "uuid", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - } - ] - }, - { - "description": "Authorizes a particular egress rule for this security group", - "isasync": true, - "name": "authorizeSecurityGroupEgress", - "params": [ + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "user to security group mapping", - "length": 255, - "name": "usersecuritygrouplist", - "required": false, - "type": "map" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "an optional account for the security group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, + {}, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", - "length": 255, - "name": "securitygroupname", - "required": false, + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "TCP is default. UDP is the other supported protocol", - "length": 255, - "name": "protocol", - "required": false, + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "an optional project of the security group", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", - "required": false, - "type": "uuid" + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" }, { - "description": "error code for this icmp message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "start port for this egress rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, { - "description": "type of the icmp message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "end port for this egress rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - } - ], - "related": "authorizeSecurityGroupIngress", - "response": [ + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, - {}, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, - {}, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "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 list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "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 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists storage pools.", - "isasync": false, - "name": "listStoragePools", - "params": [ - { - "description": "the IP address for the storage pool", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "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 storage pools belongig to the specific cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "host ID of the storage pools", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, { - "description": "the name of the storage pool", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the Pod ID for the storage pool", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", + "type": "string" + } + ] + }, + { + "description": "Creates a condition for VM auto scaling", + "isasync": true, + "name": "createCondition", + "params": [ { - "description": "the storage pool path", + "description": "the account of the condition. Must be used with the domainId parameter.", "length": 255, - "name": "path", + "name": "account", "required": false, "type": "string" }, { - "description": "", + "description": "the domain ID of the account.", "length": 255, - "name": "page", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the scope of the storage pool", + "description": "ID of the Counter.", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "string" + "name": "counterid", + "related": "createCounter,listCounters", + "required": true, + "type": "uuid" }, { - "description": "the Zone ID for the storage pool", + "description": "an optional project for condition", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "Value for which the Counter will be evaluated with the Operator selected.", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "threshold", + "required": true, + "type": "long" }, { - "description": "the status of the storage pool", + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", "length": 255, - "name": "status", - "required": false, + "name": "relationaloperator", + "required": true, "type": "string" } ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "related": "listConditions", "response": [ { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" - }, - { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" - }, - { - "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 date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" }, - {}, { - "description": "the storage pool type", - "name": "type", + "description": "the Id of the Counter.", + "name": "counterid", "type": "string" }, { - "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 name of the cluster for the storage pool", - "name": "clustername", + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the project name of the Condition", + "name": "project", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Name of the Counter.", + "name": "countername", "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 Zone name of the storage pool", - "name": "zonename", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, - { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, {}, - { - "description": "the storage pool path", - "name": "path", - "type": "string" - }, + {}, { "description": "the 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": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the owner of the Condition.", + "name": "account", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the id of the Condition", + "name": "id", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Storage provider for this pool", - "name": "provider", + "description": "zone id of counter", + "name": "zoneid", "type": "string" } ] }, { - "description": "Lists objects at specified path on an image store.", + "description": "Lists projects and provides detailed information for listed projects", "isasync": false, - "name": "listImageStoreObjects", + "name": "listProjects", "params": [ { - "description": "path to list on image store", + "description": "list projects by name", "length": 255, - "name": "path", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "id of the image store", + "description": "List projects by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" + "name": "tags", + "required": false, + "type": "map" }, { - "description": "List by keyword", + "description": "list projects by state", "length": 255, - "name": "keyword", + "name": "state", "required": false, "type": "string" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "Template ID associated with the data store object.", - "name": "templateid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", - "type": "string" - }, - { - "description": "Name of the data store object.", - "name": "name", - "type": "string" - }, - { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" - }, - { - "description": "Is it a directory.", - "name": "isdirectory", "type": "boolean" }, { - "description": "Size is in Bytes.", - "name": "size", - "type": "long" - }, - {}, - {}, - { - "description": "Format of template associated with the data store object.", - "name": "format", - "type": "string" - }, - { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Updates a hypervisor capabilities.", - "isasync": false, - "name": "updateHypervisorCapabilities", - "params": [ - { - "description": "the max number of Guest VMs per host for this hypervisor.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "maxguestslimit", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "the maximum number of the hypervisor hosts per cluster ", + "description": "list projects by project ID", "length": 255, - "name": "maxhostspercluster", + "name": "id", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "since": "4.16.0", - "type": "integer" + "type": "uuid" }, { - "description": "set true to enable storage motion support for this hypervisor", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "storagemotionenabled", + "name": "listall", "required": false, - "since": "4.16.0", "type": "boolean" }, { - "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", - "length": 255, - "name": "maxdatavolumeslimit", - "required": false, - "since": "4.16.0", - "type": "integer" - }, - { - "description": "ID of the hypervisor capability", + "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities,updateHypervisorCapabilities", + "name": "details", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "set true to enable security group for this hypervisor.", + "description": "flag to display the resource icon for projects", "length": 255, - "name": "securitygroupenabled", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "set true to enable VM snapshots for this hypervisor", + "description": "", "length": 255, - "name": "vmsnapshotenabled", + "name": "page", "required": false, - "since": "4.16.0", - "type": "boolean" - } - ], - "related": "listHypervisorCapabilities", - "response": [ - { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", "type": "integer" }, - {}, - { - "description": "the ID of the hypervisor capabilities row", - "name": "id", - "type": "string" - }, - { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "string" - }, - { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "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", + "description": "list projects by display text", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, - { - "description": "true if security group is supported", - "name": "securitygroupenabled", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the 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" - } - ], - "since": "3.0.0" - }, - { - "description": "Find hosts suitable for migrating a virtual machine.", - "isasync": false, - "name": "findHostsForMigration", - "params": [ { "description": "List by keyword", "length": 255, @@ -42097,406 +40948,463 @@ { "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,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "", + "description": "List projects by username", "length": 255, - "name": "pagesize", + "name": "username", "required": false, - "type": "integer" + "type": "string" } ], - "related": "", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "response": [ { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "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 memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "description": "the total memory (in MB) owned by project", "name": "memorytotal", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "averageload", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, + {}, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the host version", - "name": "version", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", - "type": "boolean" + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, + {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor ", - "name": "memorywithoverprovisioning", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the date and time the host was created", + "description": "the date this project was created", "name": "created", "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 resource state of the host", - "name": "resourcestate", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the 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 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": "list" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor ", - "name": "cpuwithoverprovisioning", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Enable a Cisco Nexus VSM device", - "isasync": true, - "name": "enableCiscoNexusVSM", + "description": "Creates an account", + "isasync": false, + "name": "createAccount", "params": [ { - "description": "Id of the Cisco Nexus 1000v VSM device to be enabled", + "description": "details for account used to store specific parameters", "length": 255, - "name": "id", - "related": "listCiscoNexusVSMs,enableCiscoNexusVSM,disableCiscoNexusVSM", - "required": true, - "type": "uuid" - } - ], - "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", - "response": [ + "name": "accountdetails", + "required": false, + "type": "map" + }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "length": 255, + "name": "timezone", + "required": false, + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "length": 255, + "name": "password", + "required": true, + "type": "string" }, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "required": false, "type": "string" }, - {}, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "firstname", + "length": 255, + "name": "firstname", + "required": true, "type": "string" }, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "lastname", + "length": 255, + "name": "lastname", + "required": true, "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": false, + "type": "uuid" }, { - "description": "device name", - "name": "vsmdevicename", - "type": "string" + "description": "Creates the user under the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "device state", - "name": "vsmdevicestate", + "description": "Unique username.", + "length": 255, + "name": "username", + "required": true, "type": "string" }, - {}, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "Network domain for the account's networks", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Account UUID, required for adding account from external provisioning system", + "length": 255, + "name": "accountid", + "required": false, "type": "string" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", - "type": "string" + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "length": 255, + "name": "accounttype", + "required": false, + "type": "integer" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "email", + "length": 255, + "name": "email", + "required": true, + "type": "string" + } + ], + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "response": [ + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" - } - ] - }, - { - "description": "Return true if the specified account is allowed to create offerings with tags.", - "isasync": false, - "name": "isAccountAllowedToCreateOfferingsWithTags", - "params": [ + }, { - "description": "Account UUID", - "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, { - "description": "is domain admin allowed to create offerings with tags", - "name": "isallowed", - "type": "boolean" + "description": "the state of the account", + "name": "state", + "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": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { @@ -42504,312 +41412,580 @@ "name": "jobstatus", "type": "integer" }, - {}, - {} - ] - }, - { - "description": "Dedicates a guest vlan range to an account", - "isasync": false, - "name": "dedicateGuestVlanRange", - "params": [ { - "description": "account who will own the VLAN", - "length": 255, - "name": "account", - "required": false, + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "domain ID of the account owning a VLAN", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "project who will own the VLAN", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "physical network ID of the vlan", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "guest vlan range to be dedicated", - "length": 255, - "name": "vlanrange", - "required": true, - "type": "string" - } - ], - "related": "listDedicatedGuestVlanRanges", - "response": [ + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "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 ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + } + ], + "type": "list" + }, + {}, { - "description": "the zone of the guest vlan range", - "name": "zoneid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, - {}, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the project name of the guest vlan range", - "name": "project", + "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 secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + }, + { + "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", "type": "integer" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "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 cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, {}, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" - } - ] - }, - { - "description": "Adds VM to specified network by creating a NIC", - "isasync": true, - "name": "addNicToVirtualMachine", - "params": [ + }, { - "description": "Mac Address for the new network", - "length": 255, - "name": "macaddress", - "required": false, + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "IP Address for the new network", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", "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, + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "details for the account", + "name": "accountdetails", "type": "map" }, { - "description": "Network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "Virtual Machine ID", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "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 memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + } + ] + }, + { + "description": "Revert VM from a vmsnapshot.", + "isasync": true, + "name": "revertToVMSnapshot", + "params": [ + { + "description": "The ID of the vm snapshot", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,addNicToVirtualMachine,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": true, "type": "uuid" } ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ { - "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": "the 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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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 vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -42818,29 +41994,34 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the traffic type of the nic", + "name": "traffictype", "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 IPv6 address of network", + "name": "ip6address", + "type": "string" }, { "description": "true if nic is default, false otherwise", @@ -42848,266 +42029,320 @@ "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], "type": "set" }, - {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "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": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, - {}, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "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": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "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", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", "name": "diskofferingname", "type": "string" }, - {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + {}, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -43116,242 +42351,80 @@ "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", + "description": "the name of the security group", "name": "name", "type": "string" }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "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" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "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": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the 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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "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": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -43360,94 +42433,69 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, { - "description": "the 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 description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { @@ -43455,62 +42503,32 @@ "name": "ingressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", - "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", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, - { - "description": "the 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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -43524,8 +42542,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -43533,302 +42551,234 @@ "name": "account", "type": "string" }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the type of the ICMP message response", "name": "icmptype", "type": "integer" }, { - "description": "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 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", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the 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 resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" } ], "type": "set" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "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": "Lists all static routes", - "isasync": false, - "name": "listStaticRoutes", - "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "list static routes by state", - "length": 255, - "name": "state", - "required": false, - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "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": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list static route by id", - "length": 255, - "name": "id", - "related": "listStaticRoutes", - "required": false, - "type": "uuid" - }, - { - "description": "list static routes by vpc id", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "list static routes by gateway id", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the domain associated with the static route", - "name": "domain", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - {}, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the list of resource tags associated with static route", + "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": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -43842,13 +42792,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -43860,378 +42810,674 @@ "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": "customer associated with the tag", + "name": "customer", + "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the ID of static route", - "name": "id", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "VPC gateway the route is created for", - "name": "gatewayid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + {}, { - "description": "the project name of the static route", - "name": "project", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "static route CIDR", - "name": "cidr", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the static route", - "name": "projectid", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the state of the static route", - "name": "state", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "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": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Lists all public ip addresses", - "isasync": false, - "name": "listPublicIpAddresses", + "description": "Removes a Guest OS Mapping.", + "isasync": true, + "name": "removeGuestOsMapping", "params": [ { - "description": "limits search results to allocated public IP addresses", + "description": "ID of the guest OS mapping", "length": 255, - "name": "allocatedonly", - "required": false, + "name": "id", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "List IPs belonging to the VPC", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, + {} + ], + "since": "4.4.0" + }, + { + "description": "create Tungsten-Fabric service group", + "isasync": true, + "name": "createTungstenFabricServiceGroup", + "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Tungsten-Fabric service group protocol", "length": 255, - "name": "account", - "required": false, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "Tungsten-Fabric service group name", "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "Tungsten-Fabric service group end port", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "endport", + "required": true, + "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Tungsten-Fabric service group start port", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "startport", + "required": true, + "type": "integer" }, { - "description": "lists all public IP addresses by source network ID", + "description": "the ID of zone", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.13.0", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "list only source NAT IP addresses", - "length": 255, - "name": "issourcenat", - "required": false, - "type": "boolean" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "", + "description": "Tungsten-Fabric service group uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" + }, + { + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", + "type": "string" + }, + { + "description": "Tungsten-Fabric service group name", + "name": "name", + "type": "string" + }, + { + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Recover a Shared FileSystem by id", + "isasync": false, + "name": "recoverSharedFileSystem", + "params": [ + { + "description": "the ID of the shared filesystem to recover", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "lists the specified IP address", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Registers an existing ISO into the CloudStack Cloud.", + "isasync": false, + "name": "registerIso", + "params": [ + { + "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "ipaddress", + "name": "checksum", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the virtual network for the IP address", + "description": "true if password reset feature is supported; default is false", "length": 255, - "name": "forvirtualnetwork", + "name": "passwordenabled", "required": false, "type": "boolean" }, { - "description": "lists all public IP addresses associated to the network specified", + "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "Register ISO for the project", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "lists all public IP addresses by VLAN ID", + "description": "Image store UUID", "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "imagestoreuuid", "required": false, + "type": "string" + }, + { + "description": "the ID of the zone you wish to register the ISO to.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "lists all public IP addresses by state", + "description": "true if the ISO or its derivatives are extractable; default is false", "length": 255, - "name": "state", + "name": "isextractable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "lists all public IP addresses by zone ID", + "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "ostypeid", + "related": "addGuestOs", "required": false, "type": "uuid" }, { - "description": "lists all public IP addresses by physical network ID", + "description": "the name of the ISO", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the URL to where the ISO is currently being hosted", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "the display text of the ISO, defaults to the 'name'", + "length": 4096, + "name": "displaytext", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "an optional account name. Must be used with domainId.", "length": 255, - "name": "tags", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { - "description": "lists IP address by ID", + "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", "length": 255, - "name": "id", - "related": "associateIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "isdynamicallyscalable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list only IPs used for load balancing", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "forloadbalancing", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "list only static NAT IP addresses", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "isstaticnat", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" + }, + { + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", + "required": false, + "type": "boolean" } ], - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the project name of the address", + "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 userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the project name of the template", "name": "project", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "public IP address id", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the domain the public IP address is associated with", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + {}, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the name of the domain to which the template belongs", "name": "domain", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the list of resource tags associated with ip address", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -44240,13 +43486,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -44255,1539 +43501,1647 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], - "type": "list" + "type": "set" }, - {}, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "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 entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, - {}, { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "is public IP portable across the zones", - "name": "isportable", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + {} + ] + }, + { + "description": "Lists Cisco ASA 1000v appliances", + "isasync": false, + "name": "listCiscoAsa1000vResources", + "params": [ + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "Cisco ASA 1000v resource ID", + "length": 255, + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "required": false, + "type": "uuid" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" + } + ], + "related": "addCiscoAsa1000vResource", + "response": [ + {}, + {}, + {}, + { + "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "deletes a range of portable public IP's associated with a region", + "isasync": true, + "name": "deletePortableIpRange", + "params": [ + { + "description": "Id of the portable ip range", + "length": 255, + "name": "id", + "related": "createPortableIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status 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": "Updates an ISO file.", + "description": "Upgrades router to use newer template", "isasync": false, - "name": "updateIso", + "name": "upgradeRouterTemplate", "params": [ { - "description": "the name of the image file", + "description": "upgrades all routers owned by the specified domain", "length": 255, - "name": "name", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "upgrades router with the specified Id", "length": 255, - "name": "bootable", + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "upgrades all routers within the specified zone", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "upgrades all routers within the specified cluster", "length": 255, - "name": "requireshvm", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the format for the image", + "description": "upgrades all routers within the specified pod", "length": 255, - "name": "format", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "upgrades all routers owned by the specified account", "length": 255, - "name": "isdynamicallyscalable", + "name": "account", "required": false, - "type": "boolean" + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ] + }, + { + "description": "Lists IPv4 subnets for guest networks.", + "isasync": false, + "name": "listIpv4SubnetsForGuestNetwork", + "params": [ + { + "description": "UUID of VPC to which the IPv4 subnet is associated to.", "length": 255, - "name": "sshkeyenabled", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", "length": 255, - "name": "details", + "name": "parentid", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "description": "", + "length": 255, + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "UUID of zone to which the IPv4 subnet belongs to.", "length": 255, - "name": "isrouting", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "sort key of the template, integer", + "description": "The CIDR of the Ipv4 subnet.", "length": 255, - "name": "sortkey", + "name": "subnet", "required": false, - "type": "integer" + "type": "string" }, { - "description": "true if the image supports the password reset feature; default is false", + "description": "List by keyword", "length": 255, - "name": "passwordenabled", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the image file", + "description": "UUID of the IPv4 subnet for guest network.", "length": 255, "name": "id", - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, + "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", + "required": false, "type": "uuid" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "description": "UUID of network to which the IPv4 subnet is associated to.", "length": 255, - "name": "cleanupdetails", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], - "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "createIpv4SubnetForGuestNetwork", "response": [ { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "id of the data center IPv4 subnet", + "name": "parentid", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "id of the IPv4 subnet for guest network", + "name": "id", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, - {}, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", + "type": "string" }, + {}, + {}, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "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": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", + "type": "string" }, { - "description": "the template ID", + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" + } + ], + "since": "4.20.0" + }, + { + "description": "Cancels host maintenance.", + "isasync": true, + "name": "cancelHostMaintenance", + "params": [ + { + "description": "the host ID", + "length": 255, "name": "id", + "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "response": [ + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, - {}, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the status of the template", - "name": "status", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" + }, + {}, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "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 zone for this template", - "name": "zonename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the size of the template", - "name": "size", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "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 host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" - } - ] - }, - { - "description": "Lists OpenDaylight controllers", - "isasync": false, - "name": "listOpenDaylightControllers", - "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" }, { - "description": "the ID of a OpenDaylight Controller", - "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", - "required": false, - "type": "uuid" - } - ], - "related": "addOpenDaylightController,deleteOpenDaylightController", - "response": [ - {}, - {}, + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name assigned to the controller", - "name": "name", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "device id of the controller", - "name": "id", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the url of the controller api", - "name": "url", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" - } - ] - }, - { - "description": "Adds a BigSwitch BCF Controller device", - "isasync": true, - "name": "addBigSwitchBcfDevice", - "params": [ + }, + {}, { - "description": "Username of the BigSwitch BCF Controller.", - "length": 255, - "name": "username", - "required": true, - "type": "string" + "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": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + } + ], + "type": "list" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "Hostname of ip address of the BigSwitch BCF Controller.", - "length": 255, - "name": "hostname", - "required": true, + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "NAT support of the BigSwitch BCF Controller.", - "length": 255, - "name": "nat", - "required": true, - "type": "boolean" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "Password of the BigSwitch BCF Controller.", - "length": 255, - "name": "password", - "required": true, - "type": "string" - } - ], - "related": "listBigSwitchBcfDevices", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "device name", - "name": "bigswitchdevicename", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "NAT support", - "name": "nat", + "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", - "type": "integer" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the controller password", - "name": "password", + "description": "the host version", + "name": "version", "type": "string" }, - {}, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the controller Ip address", - "name": "hostname", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the controller username", - "name": "username", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" + }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "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" } - ], - "since": "4.6.0" + ] }, { - "description": "Deletes a counter for VM auto scaling", - "isasync": true, - "name": "deleteCounter", + "description": "Lists all VLAN IP ranges.", + "isasync": false, + "name": "listVlanIpRanges", "params": [ { - "description": "the ID of the counter", + "description": "the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "the Pod ID of the VLAN IP range", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "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": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the VLAN IP range", "length": 255, "name": "id", - "related": "createCounter,listCounters", - "required": true, + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "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": "network id of the VLAN IP range", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the Zone ID of the VLAN IP range", + "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": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + }, + { + "description": "physical network id of the VLAN IP range", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, "type": "uuid" } ], + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project id of the vlan range", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the start ip of the VLAN IP range", + "name": "startip", + "type": "string" + }, + { + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "type": "string" + }, + { + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" + }, + { + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" + }, + { + "description": "the domain name of the VLAN IP range", + "name": "domain", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, {}, + { + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" + }, + { + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", + "type": "boolean" + }, + { + "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 netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "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 current status 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 project name of the vlan range", + "name": "project", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "the ID of the VLAN IP range", + "name": "id", + "type": "string" + }, + { + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", + "type": "string" + }, + { + "description": "the account of the VLAN IP range", + "name": "account", + "type": "string" + }, + { + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" + } ] }, { - "description": "Changes the default NIC on a VM", - "isasync": true, - "name": "updateDefaultNicForVirtualMachine", + "description": "Updates a Zone.", + "isasync": false, + "name": "updateZone", "params": [ { - "description": "Virtual Machine ID", + "description": "the dns search order list", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateDefaultNicForVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "dnssearchorder", + "required": false, + "type": "list" }, { - "description": "NIC ID", + "description": "the dhcp Provider for the Zone", "length": 255, - "name": "nicid", - "related": "", + "name": "dhcpprovider", + "required": false, + "type": "string" + }, + { + "description": "the name of the Zone", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "sort key of the zone, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "the first DNS for the Zone", + "length": 255, + "name": "dns1", + "required": false, + "type": "string" + }, + { + "description": "the details for the Zone", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the first internal DNS for the Zone", + "length": 255, + "name": "internaldns1", + "required": false, + "type": "string" + }, + { + "description": "the second DNS for the Zone", + "length": 255, + "name": "dns2", + "required": false, + "type": "string" + }, + { + "description": "the first DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns1", + "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 second internal DNS for the Zone", + "length": 255, + "name": "internaldns2", + "required": false, + "type": "string" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "length": 255, + "name": "localstorageenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the Zone", + "length": 255, + "name": "id", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "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": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "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" } ], - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "createZone,listZones,listZones", "response": [ { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, { - "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 Mode", - "name": "bootmode", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the name of the affinity group", + "description": "the capacity name", "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 account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "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 list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" } ], - "type": "set" + "type": "list" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the second internal DNS for the Zone", + "name": "internaldns2", + "type": "string" + }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, + { + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + { + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" + }, + { + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the 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 (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "Zone description", + "name": "description", + "type": "string" }, {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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 Zone", + "name": "dns2", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" + }, + { + "description": "the first DNS for the Zone", + "name": "dns1", + "type": "string" + }, + { + "description": "the UUID of the containing domain, null for public zones", "name": "domainid", "type": "string" + } + ] + }, + { + "description": "Extracts volume", + "isasync": true, + "name": "extractVolume", + "params": [ + { + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the url to which the volume would be extracted", + "length": 2048, + "name": "url", + "required": false, "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the zone where the volume is located", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "extractIso,extractSnapshot,extractTemplate,downloadImageStoreObject", + "response": [ + { + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "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 number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project id of the group", - "name": "projectid", - "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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "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 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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the id of extracted object", + "name": "id", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, - {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the virtual machine", + "description": "the state of the extracted object", + "name": "state", + "type": "string" + }, + { + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" + }, + {}, + { + "description": "the name of the extracted object", "name": "name", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the status of the extraction", + "name": "status", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Releases an existing dedicated IPv4 subnet for a zone.", + "isasync": true, + "name": "releaseIpv4SubnetForZone", + "params": [ + { + "description": "Id of the guest network IPv4 subnet", + "length": 255, + "name": "id", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "required": true, + "type": "uuid" + } + ], + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "response": [ + { + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { @@ -45796,33 +45150,39 @@ "type": "integer" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + {}, + { + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { @@ -45831,381 +45191,468 @@ "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, + {}, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Lists project's accounts", + "isasync": false, + "name": "listProjectAccounts", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "list invitation by user ID", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "list accounts of the project by account name", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "list accounts of the project by project role id", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "ID of the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "list accounts of the project by role", + "length": 255, + "name": "role", + "required": false, "type": "string" - }, + } + ], + "related": "activateProject,createProject,suspendProject,updateProject", + "response": [ { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, - {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "list" }, + {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "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 total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", + "description": "the domain name where the project belongs to", "name": "domain", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the displaytext of the project", + "name": "displaytext", "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 virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" - } - ] - }, - { - "description": "Generate DRS plan for a cluster", - "isasync": false, - "name": "generateClusterDrsPlan", - "params": [ + }, { - "description": "the ID of the Cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting", - "length": 255, - "name": "migrations", - "required": false, - "type": "integer" - } - ], - "related": "executeClusterDrsPlan", - "response": [ - {}, + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" }, { - "description": "Start event Id of the DRS Plan", - "name": "eventid", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "Id of the cluster", - "name": "clusterid", - "type": "string" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" }, {}, { - "description": "unique ID of the drs plan for cluster", - "name": "id", + "description": "the state of the project", + "name": "state", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Deletes a user for an account", - "isasync": false, - "name": "deleteUser", - "params": [ - { - "description": "id of the user to be deleted", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", "type": "integer" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" } - ] + ], + "since": "3.0.0" }, { - "description": "Initiates the specified power action to the host's out-of-band management interface", + "description": "Updates an existing autoscale policy.", "isasync": true, - "name": "issueOutOfBandManagementPowerAction", + "name": "updateAutoScalePolicy", "params": [ { - "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", + "description": "the duration in which the conditions have to be true before action is taken", "length": 255, - "name": "action", - "required": true, - "type": "string" + "name": "duration", + "required": false, + "type": "integer" }, { - "description": "the ID of the host", + "description": "the ID of the autoscale policy", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "id", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, "type": "uuid" }, { - "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "timeout", + "name": "quiettime", "required": false, - "type": "long" + "type": "integer" + }, + { + "description": "the name of the autoscale policy", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "length": 255, + "name": "conditionids", + "related": "listConditions", + "required": false, + "type": "list" } ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster", + "related": "listAutoScalePolicies", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the out-of-band management interface port", - "name": "port", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -46213,145 +45660,114 @@ "type": "integer" }, { - "description": "the out-of-band management interface username", - "name": "username", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the autoscale policy ID", + "name": "id", + "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, {}, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, + {}, { - "description": "the operation result description", - "name": "description", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" } - ], - "since": "4.9.0" + ] }, { - "description": "Issues a client certificate using configured or provided CA plugin", + "description": "Creates a IPv4 subnet for a zone.", "isasync": true, - "name": "issueCertificate", + "name": "createIpv4SubnetForZone", "params": [ { - "description": "Certificate validity duration in number of days, when not provided the default configured value will be used", + "description": "The CIDR of the IPv4 subnet.", "length": 255, - "name": "duration", - "required": false, - "type": "integer" + "name": "subnet", + "required": true, + "type": "string" }, { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "description": "project who will own the IPv4 subnet", "length": 255, - "name": "provider", + "name": "projectid", + "related": "activateProject,createProject,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", - "length": 65535, - "name": "csr", + "description": "account who will own the IPv4 subnet", + "length": 255, + "name": "account", "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", + "description": "UUID of the zone which the IPv4 subnet belongs to.", "length": 255, - "name": "domain", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "Comma separated list of IP addresses, the certificate should be issued for", + "description": "domain ID of the account owning the IPv4 subnet", "length": 255, - "name": "ipaddress", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "listCaCertificate", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "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": "Private key for the certificate", - "name": "privatekey", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, {}, { - "description": "The client certificate", - "name": "certificate", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, - {} - ], - "since": "4.11.0" - }, - { - "description": "Deletes network device.", - "isasync": false, - "name": "deleteNetworkDevice", - "params": [ - { - "description": "Id of network device to delete", - "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, {}, @@ -46360,76 +45776,24 @@ "name": "jobid", "type": "string" }, - {} - ] - }, - { - "description": "Updates image store read-only status", - "isasync": false, - "name": "updateImageStore", - "params": [ - { - "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", - "length": 255, - "name": "readonly", - "required": true, - "type": "boolean" - }, - { - "description": "Image Store UUID", - "length": 255, - "name": "id", - "related": "addSecondaryStorage,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" - } - ], - "related": "addSecondaryStorage,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "response": [ - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" - }, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the provider name of the image store", - "name": "providername", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { - "description": "the ID of the image store", + "description": "id of the guest IPv4 subnet", "name": "id", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { @@ -46438,442 +45802,328 @@ "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, - { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - {}, - { - "description": "the name of the image store", - "name": "name", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" } ], - "since": "4.15.0" + "since": "4.20.0" }, { - "description": "Creates a port forwarding rule", - "isasync": true, - "name": "createPortForwardingRule", + "description": "Creates a disk offering.", + "isasync": false, + "name": "createDiskOffering", "params": [ { - "description": "VM guest nic secondary IP address for the port forwarding rule", + "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "vmguestip", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", "required": false, - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "length": 255, - "name": "publicport", - "required": true, - "type": "integer" - }, - { - "description": "the IP address id of the port forwarding rule", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, + "since": "4.15", "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.", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "cidrlist", + "name": "bytesreadrate", "required": false, - "type": "list" + "type": "long" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", "length": 255, - "name": "fordisplay", + "name": "cachemode", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.14", + "type": "string" }, { - "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", + "description": "name of the disk offering", "length": 255, - "name": "protocol", + "name": "name", "required": true, "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", + "description": "length (in seconds) of the burst", "length": 255, - "name": "privateport", - "required": true, - "type": "integer" + "name": "iopsreadratemaxlength", + "required": false, + "type": "long" }, { - "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": "max iops of the disk offering", "length": 255, - "name": "openfirewall", + "name": "maxiops", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "the ending port of port forwarding rule's private port range", + "description": "whether disk offering size is custom or not", "length": 255, - "name": "publicendport", + "name": "customized", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ending port of port forwarding rule's private port range", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "privateendport", + "name": "bytesreadratemax", "required": false, - "type": "integer" + "type": "long" }, { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "provisioningtype", + "required": false, + "type": "string" }, { - "description": "the network of the virtual machine the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).", + "description": "min iops of the disk offering", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "miniops", "required": false, - "type": "uuid" - } - ], - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", - "response": [ + "type": "long" + }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "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 starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopswriteratemaxlength", + "required": false, + "type": "long" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, "type": "list" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "description": "Volumes using this offering should be encrypted", + "length": 255, + "name": "encrypt", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, + "type": "long" }, - {}, - {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "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": "the state of the rule", - "name": "state", - "type": "string" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "length": 255, + "name": "hypervisorsnapshotreserve", + "required": false, + "type": "integer" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "byteswriteratemaxlength", + "required": false, + "type": "long" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" + "description": "details to specify disk offering parameters", + "length": 255, + "name": "details", + "required": false, + "since": "4.16", + "type": "map" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "tags for the disk offering", + "length": 4096, + "name": "tags", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the containing zone(s), null for public offerings", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "list" }, { - "description": "the ID of the port forwarding rule", - "name": "id", - "type": "string" + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "type": "long" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" + "description": "io requests write rate of the disk offering", + "length": 255, + "name": "iopswriterate", + "required": false, + "type": "long" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", + "required": false, + "type": "long" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "length": 255, + "name": "disksizestrictness", + "required": false, + "since": "4.17", + "type": "boolean" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "length": 255, + "name": "iopswriteratemax", + "required": false, + "type": "long" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the storage type of the disk offering. Values are local and shared.", + "length": 255, + "name": "storagetype", + "required": false, "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "An alternate display text of the disk offering, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Dedicates a zones.", - "isasync": true, - "name": "dedicateZone", - "params": [ - { - "description": "the ID of the containing domain", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": true, - "type": "uuid" + "name": "iopsreadrate", + "required": false, + "type": "long" }, { - "description": "the ID of the zone", + "description": "whether disk offering iops is custom or not", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "customizediops", + "required": false, + "type": "boolean" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "account", + "name": "byteswriteratemax", "required": false, - "type": "string" + "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 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 Account Id to which the Zone is dedicated", - "name": "accountid", - "type": "string" - }, - { - "description": "the ID of the Zone", - "name": "zoneid", + "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 dedicated resource", + "description": "unique ID of the disk offering", "name": "id", "type": "string" }, - { - "description": "the Name of the Zone", - "name": "zonename", - "type": "string" - }, {}, - {} - ] - }, - { - "description": "load template into primary storage", - "isasync": false, - "name": "prepareTemplate", - "params": [ { - "description": "template ID of the template to be prepared in primary storage(s).", - "length": 255, - "name": "templateid", - "related": "prepareTemplate,listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", + "name": "disksizestrictness", + "type": "boolean" }, { - "description": "zone ID of the template to be prepared in primary storage(s).", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" - } - ], - "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the name of the disk offering", + "name": "name", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" }, + {}, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "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", @@ -46881,297 +46131,148 @@ "type": "integer" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "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 the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "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 template display text", - "name": "displaytext", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", + "name": "suitableforvirtualmachine", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "type": "string" - }, - { - "description": "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": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - {}, - { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", - "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": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "state of the disk offering", + "name": "state", "type": "string" }, - {}, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" - }, - { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the storage type for this disk offering", + "name": "storagetype", "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": "whether to display the offering to the end user or not.", + "name": "displayoffering", "type": "boolean" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the template name", - "name": "name", - "type": "string" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the status of the template", - "name": "status", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "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 type of the template", - "name": "templatetype", - "type": "string" + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" } ] }, { - "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", - "isasync": true, - "name": "assignToLoadBalancerRule", + "description": "Lists details of network protocols", + "isasync": false, + "name": "listNetworkProtocols", "params": [ { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", - "length": 255, - "name": "vmidipmap", - "required": false, - "since": "4.4", - "type": "map" - }, - { - "description": "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)", - "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "list" - }, - { - "description": "the ID of the load balancer rule", + "description": "The option of network protocols. Supported values are: protocolnumber, icmptype.", "length": 255, - "name": "id", - "related": "createIpv6FirewallRule,updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "name": "option", "required": true, - "type": "uuid" + "type": "string" } ], + "related": "", "response": [ + { + "description": "the details of the protocol parameter", + "name": "details", + "type": "map" + }, + { + "description": "the name of the protocol parameter", + "name": "name", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -47179,65 +46280,37 @@ }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the index (ID, Value, Code, Type, Option, etc) of the protocol parameter", + "name": "index", + "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the description of the protocol parameter", + "name": "description", + "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } - ] + ], + "since": "4.19.0" }, { - "description": "Lists all pending asynchronous jobs for the account.", + "description": "Lists load balancer health check policies.", "isasync": false, - "name": "listAsyncJobs", + "name": "listLBHealthCheckPolicies", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "The id of the management server", + "description": "the ID of the health check policy", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "id", + "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "required": false, - "since": "4.19", + "since": "4.4", "type": "uuid" }, - { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, { "description": "", "length": 255, @@ -47253,636 +46326,250 @@ "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isrecursive", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the load balancer rule", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": false, "type": "uuid" - } - ], - "related": "queryAsyncJobResult", - "response": [ - { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" - }, - { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", - "type": "string" - }, - {}, - { - "description": " the created date of the job", - "name": "created", - "type": "date" - }, - {}, - { - "description": "the 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 result reason", - "name": "jobresult", - "type": "responseobject" - }, - { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" - }, - { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", - "type": "string" }, { - "description": "the async command executed", - "name": "cmd", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "createLBHealthCheckPolicy", + "response": [ { - "description": "the domain id that executed the async command", + "description": "the domain ID of the HealthCheck policy", "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account that executed the async command", - "name": "account", - "type": "string" - }, - { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" - }, - { - "description": "the domain that executed the async command", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account id that executed the async command", - "name": "accountid", - "type": "string" + "description": "the list of healthcheckpolicies", + "name": "healthcheckpolicy", + "response": [ + { + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" + }, + { + "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": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" + }, + { + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", + "type": "int" + }, + { + "description": "the description of the healthcheck policy", + "name": "description", + "type": "string" + }, + { + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", + "type": "string" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + } + ], + "type": "list" }, { - "description": "the result type", - "name": "jobresulttype", + "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 user that executed the async command", - "name": "userid", - "type": "string" - } - ] - }, - { - "description": "Archive one or more alerts.", - "isasync": false, - "name": "archiveAlerts", - "params": [ - { - "description": "archive by alert type", - "length": 255, - "name": "type", - "required": false, + "description": "the account of the HealthCheck policy", + "name": "account", "type": "string" }, { - "description": "the IDs of the alerts", - "length": 255, - "name": "ids", - "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": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } - ] + ], + "since": "4.2.0" }, { - "description": "Lists all Buckets.", - "isasync": false, - "name": "listBuckets", + "description": "Attempts Migration of a VM with its volumes to a different host", + "isasync": true, + "name": "migrateVirtualMachineWithVolume", "params": [ { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "the IDs of the Buckets, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "listBuckets", - "required": false, - "type": "list" - }, - { - "description": "", + "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", "length": 255, - "name": "pagesize", + "name": "autoselect", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "boolean" }, { - "description": "the ID of the bucket", + "description": "the ID of the virtual machine", "length": 255, - "name": "id", - "related": "listBuckets", - "required": false, + "name": "virtualmachineid", + "related": "assignVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the object storage pool, available to ROOT admin only", + "description": "Destination Host ID to migrate VM to.", "length": 255, - "name": "objectstorageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "hostid", + "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "the name of the bucket", + "description": "Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", "length": 255, - "name": "name", + "name": "migrateto", "required": false, - "type": "string" - }, + "type": "map" + } + ], + "related": "assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "response": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, + {}, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "ID of the Bucket", - "name": "id", - "type": "string" - }, - { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", - "type": "string" - }, - { - "description": "Bucket URL", - "name": "url", - "type": "string" - }, - { - "description": "Bucket Quota in GB", - "name": "quota", - "type": "integer" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Bucket Access Key", - "name": "accesskey", - "type": "string" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" - } - ], - "type": "set" - }, - { - "description": "name of the Bucket", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id of the bucket", - "name": "projectid", - "type": "string" - }, - { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" - }, - { - "description": "Object storage provider", - "name": "provider", - "type": "string" - }, - { - "description": "Bucket Object Locking", - "name": "objectlocking", - "type": "boolean" - }, - { - "description": "State of the Bucket", - "name": "state", - "type": "string" - }, - { - "description": "the project name of the bucket", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the bucket", - "name": "domain", - "type": "string" - }, - { - "description": "Bucket Access Policy", - "name": "policy", - "type": "string" - }, - { - "description": "Bucket Secret Key", - "name": "usersecretkey", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" - }, - { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", - "type": "string" - }, - { - "description": "Bucket Versioning", - "name": "versioning", - "type": "boolean" - }, - { - "description": "the account associated with the Bucket", - "name": "account", - "type": "string" - }, - {}, - { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" - } - ], - "since": "4.19.0" - }, - { - "description": "Deletes a Cisco Vnmc controller", - "isasync": false, - "name": "deleteCiscoVnmcResource", - "params": [ - { - "description": "Cisco Vnmc resource ID", - "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status 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": "Creates a secondary storage selector, described by the heuristic rule.", - "isasync": false, - "name": "createSecondaryStorageSelector", - "params": [ - { - "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", - "length": 65535, - "name": "heuristicrule", - "required": true, - "type": "string" - }, - { - "description": "The name identifying the heuristic rule.", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "The description of the heuristic rule.", - "length": 255, - "name": "description", - "required": true, - "type": "string" - }, - { - "description": "The zone in which the heuristic rule will be applied.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "length": 255, - "name": "type", - "required": true, - "type": "string" - } - ], - "related": "updateSecondaryStorageSelector,removeSecondaryStorageSelector", - "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 heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", - "type": "string" - }, - { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", - "type": "string" - }, - { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" - }, - { - "description": "Description of the heuristic.", - "name": "description", - "type": "string" - }, - { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", - "type": "string" - }, - { - "description": "ID of the heuristic.", - "name": "id", - "type": "string" - }, - { - "description": "Name of the heuristic.", - "name": "name", - "type": "string" - }, - { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" - }, - {} - ], - "since": "4.19.0" - }, - { - "description": "Stops an Internal LB vm.", - "isasync": true, - "name": "stopInternalLoadBalancerVM", - "params": [ - { - "description": "the ID of the internal lb vm", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" - }, - { - "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - } - ], - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "response": [ - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ + }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -47891,8 +46578,8 @@ "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -47900,59 +46587,44 @@ "name": "adaptertype", "type": "string" }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, { "description": "the isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -47961,8 +46633,8 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -47970,341 +46642,199 @@ "name": "nsxlogicalswitchport", "type": "string" }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, { "description": "the isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, { "description": "MTU configured on the NIC", "name": "mtu", "type": "integer" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" } ], "type": "set" }, { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the project name of the address", + "description": "the project name of the vm", "name": "project", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "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": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "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 router", - "name": "id", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the name of the affinity group", + "name": "name", + "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the 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 account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" } ], - "type": "list" - }, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" + "type": "set" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, - {}, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the date and time the router was created", + "description": "the date when this virtual machine was created", "name": "created", "type": "date" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "type": "string" - }, - { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - {}, - { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { @@ -48313,382 +46843,195 @@ "type": "boolean" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - } - ] - }, - { - "description": "Adds a Brocade VCS Switch", - "isasync": true, - "name": "addBrocadeVcsDevice", - "params": [ - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "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", - "required": true, - "type": "string" - }, - { - "description": "Credentials to access the Brocade VCS Switch API", - "length": 255, - "name": "username", - "required": true, - "type": "string" - } - ], - "related": "listBrocadeVcsDevices", - "response": [ - { - "description": "the principal switch Ip address", - "name": "hostname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "device name", - "name": "brocadedevicename", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, - {}, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - } - ] - }, - { - "description": "Updates a security group", - "isasync": false, - "name": "updateSecurityGroup", - "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "The new name of the security group.", - "length": 255, - "name": "name", - "required": false, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "The ID of the security group.", - "length": 255, - "name": "id", - "related": "createSecurityGroup,updateSecurityGroup", - "required": true, - "type": "uuid" - } - ], - "related": "createSecurityGroup", - "response": [ - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", + "description": "the project name of the group", "name": "project", "type": "string" }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag 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": "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 project id of the group", - "name": "projectid", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the 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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -48697,8 +47040,23 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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" }, { @@ -48706,665 +47064,767 @@ "name": "key", "type": "string" }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "customer associated with the tag", "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" + } + ], + "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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "tag value", - "name": "value", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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 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" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "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 project name where tag belongs to", - "name": "project", + "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the ID of the security group", + "name": "id", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" } ], "type": "set" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, {}, { - "description": "the name of the security group", - "name": "name", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" - } - ], - "since": "4.14.0.0" - }, - { - "description": "Creates a domain", - "isasync": false, - "name": "createDomain", - "params": [ + }, { - "description": "Domain UUID, required for adding domain from another Region", - "length": 255, - "name": "domainid", - "required": false, - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "Network domain for networks in the domain", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "creates domain with this name", - "length": 255, - "name": "name", - "required": true, + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.", - "length": 255, - "name": "parentdomainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "listDomainChildren,listDomains,listDomains", - "response": [ - { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, + {}, { - "description": "the state of the domain", - "name": "state", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the 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 domain", - "name": "primarystorageavailable", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the ID of the domain", - "name": "id", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, - {}, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, - {}, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the path of the domain", - "name": "path", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", - "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 volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the name of the domain", - "name": "name", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the project id of the vm", + "name": "projectid", "type": "string" } ] }, { - "description": "Deleting resource tag(s)", - "isasync": true, - "name": "deleteTags", + "description": "Updates a user account", + "isasync": false, + "name": "updateUser", "params": [ { - "description": "Delete tags matching key/value pairs", + "description": "email", "length": 255, - "name": "tags", + "name": "email", "required": false, - "type": "map" + "type": "string" }, { - "description": "Delete tag by resource type", + "description": "The API key for the user. Must be specified with userSecretKey", "length": 255, - "name": "resourcetype", - "required": true, + "name": "userapikey", + "required": false, "type": "string" }, { - "description": "Delete tags for resource id(s)", + "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", + "name": "mandate2fa", + "required": false, + "since": "4.18.0.0", "type": "boolean" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ], - "since": "4.0.0" - }, - { - "description": "create Tungsten-Fabric tag type", - "isasync": true, - "name": "createTungstenFabricTagType", - "params": [ { - "description": "Tungsten-Fabric tag type name", + "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", "length": 255, - "name": "name", - "required": true, + "name": "password", + "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "Current password that was being used by the user. You must inform the current password when updating the password.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "listTungstenFabricTagType", - "response": [ - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "name": "currentpassword", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "description": "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": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "last name", + "length": 255, + "name": "lastname", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Unique username", + "length": 255, + "name": "username", + "required": false, "type": "string" }, - {} - ] - }, - { - "description": "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules", - "isasync": true, - "name": "restartNetwork", - "params": [ { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "description": "The secret key for the user. Must be specified with userApiKey", "length": 255, - "name": "livepatch", + "name": "usersecretkey", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "string" }, { - "description": "The ID of the network to restart.", + "description": "User uuid", "length": 255, "name": "id", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": true, "type": "uuid" }, { - "description": "Turn the network into a network with redundant routers.", - "length": 255, - "name": "makeredundant", - "required": false, - "since": "4.11.1", - "type": "boolean" - }, - { - "description": "If cleanup old network elements", + "description": "first name", "length": 255, - "name": "cleanup", + "name": "firstname", "required": false, - "type": "boolean" + "type": "string" } ], + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, - {} - ] - }, - { - "description": "Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", - "isasync": false, - "name": "login", - "params": [ { - "description": "Username", - "length": 255, + "description": "the user name", "name": "username", - "required": true, "type": "string" }, + {}, { - "description": "Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", - "length": 255, - "name": "password", - "required": true, + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", - "length": 255, + "description": "the domain name of the user", "name": "domain", - "required": false, "type": "string" }, { - "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", - "length": 255, - "name": "domainId", - "required": false, - "type": "long" - } - ], - "related": "", - "response": [ + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, { - "description": "the time period before the session has expired", - "name": "timeout", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "first name of the user", - "name": "firstname", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "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": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "user time zone", - "name": "timezone", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "Username", - "name": "username", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the account name the user belongs to", + "description": "the account name of the user", "name": "account", "type": "string" }, - {}, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "last name of the user", - "name": "lastname", + "description": "the user ID", + "name": "id", "type": "string" }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, {}, { - "description": "Is two factor authentication verified", - "name": "is2faverified", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "Domain ID that the user belongs to", + "description": "the domain ID of the user", "name": "domainid", "type": "string" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "the type of the role", + "name": "roletype", "type": "string" + } + ] + }, + { + "description": "Removes a certificate from a load balancer rule", + "isasync": true, + "name": "removeCertFromLoadBalancer", + "params": [ + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "User ID", - "name": "userid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -49372,809 +47832,589 @@ "name": "jobid", "type": "string" }, - { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", - "type": "string" - } + {} ] }, { - "description": "Lists all hypervisor capabilities.", + "description": "Adds a new host.", "isasync": false, - "name": "listHypervisorCapabilities", + "name": "addHost", "params": [ { - "description": "the hypervisor for which to restrict the search", + "description": "the cluster name for the host", "length": 255, - "name": "hypervisor", + "name": "clustername", "required": false, "type": "string" }, { - "description": "", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "pagesize", + "name": "password", "required": false, - "type": "integer" + "type": "string" }, { - "description": "ID of the hypervisor capability", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "id", - "related": "listHypervisorCapabilities", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the cluster ID for the host", "length": 255, - "name": "page", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the Pod ID for the host", "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "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 hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - {}, - { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the hypervisor type", + "description": "hypervisor type of the host", + "length": 255, "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the maximum number of Data Volumes that can be attached for this hypervisor", - "name": "maxdatavolumeslimit", - "type": "integer" - }, - { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", - "type": "boolean" - } - ], - "since": "3.0.0" - }, - { - "description": "Adds backup image store.", - "isasync": false, - "name": "addImageStore", - "params": [ - { - "description": "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "the name for the image store", + "description": "the Zone ID for the host", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the image store provider name", + "description": "the host URL", "length": 255, - "name": "provider", + "name": "url", "required": true, "type": "string" }, { - "description": "the Zone ID for the image store", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "allocationstate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the URL for the image store", - "length": 2048, - "name": "url", + "description": "list of tags to be added to the host", + "length": 255, + "name": "hosttags", "required": false, - "type": "string" + "type": "list" } ], - "related": "addSecondaryStorage,listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "response": [ - {}, - { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the name of the image store", - "name": "name", - "type": "string" - }, - { - "description": "defines if store is read-only", - "name": "readonly", + "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 scope of the image store", - "name": "scope", - "type": "scopetype" - }, - { - "description": "the url of the image store", - "name": "url", - "type": "string" - }, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, - { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, - { - "description": "the ID of the image store", - "name": "id", - "type": "string" - }, - { - "description": "the provider name of the image store", - "name": "providername", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ], - "since": "4.2.0" - }, - { - "description": "Revoke a direct download certificate from hosts in a zone", - "isasync": false, - "name": "revokeTemplateDirectDownloadCertificate", - "params": [ - { - "description": "(optional) hypervisor type", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "(optional) alias of the SSL certificate", - "length": 255, - "name": "name", - "required": false, + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, - { - "description": "(optional) zone to revoke certificate", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "(optional) the host ID to revoke certificate", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" - }, - { - "description": "id of the certificate", - "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", - "required": false, - "type": "uuid" - } - ], - "related": "provisionTemplateDirectDownloadCertificate", - "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, - {}, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" - } - ], - "since": "4.13" - }, - { - "description": "Syncs capabilities of storage pools", - "isasync": false, - "name": "updateStorageCapabilities", - "params": [ - { - "description": "Storage pool id", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" - } - ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "response": [ + }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", + "description": "the cluster ID of the host", "name": "clusterid", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "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", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" - }, - {}, - { - "description": "the storage pool path", - "name": "path", - "type": "string" - }, - { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the ID of the storage pool", + "description": "the ID of the host", "name": "id", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", + "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 storage pool", - "name": "name", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" - } - ], - "since": "4.16.0" - }, - { - "description": "Delete Project roles in CloudStack", - "isasync": false, - "name": "deleteProjectRole", - "params": [ - { - "description": "ID of the project from where the role is to be deleted", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "description": "ID of the project role to be deleted", - "length": 255, - "name": "id", - "related": "createProjectRole,listProjectRoles,updateProjectRole", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} - ], - "since": "4.15.0" - }, - { - "description": "Changes ownership of a Volume from one account to another.", - "isasync": false, - "name": "assignVolume", - "params": [ - { - "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", - "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - }, - { - "description": "The ID of the volume to be reassigned.", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume", - "required": true, - "type": "uuid" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, + {}, { - "description": "The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the state of the disk volume", + "description": "the state of the host", "name": "state", - "type": "string" + "type": "status" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "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 X resolution per display", + "name": "maxresolutionx", + "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 displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "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" + } + ], + "type": "list" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the Zone name of the host", + "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": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - }, + } + ] + }, + { + "description": "Attaches a disk volume to a virtual machine.", + "isasync": true, + "name": "attachVolume", + "params": [ { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.
When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", + "length": 255, + "name": "deviceid", + "required": false, + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": " the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "response": [ { "description": "the name of the template for the virtual machine", "name": "templatename", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", + "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": "ID of the availability zone", - "name": "zoneid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, + {}, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "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 write (IO) of disk on the vm", @@ -50182,52 +48422,62 @@ "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "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" }, { @@ -50235,11 +48485,6 @@ "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", @@ -50251,36 +48496,36 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { @@ -50289,13 +48534,23 @@ "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { @@ -50304,79 +48559,63 @@ "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "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": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "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" - } - ], - "since": "4.18.0.0" - }, - { - "description": "Deletes a userdata", - "isasync": false, - "name": "deleteUserData", - "params": [ + }, { - "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "an optional project for the userdata", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the ID of the Userdata", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "an optional account for the userdata. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" - } - ], - "response": [ + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { @@ -50385,556 +48624,562 @@ "type": "integer" }, {}, - {} - ], - "since": "4.18" - }, - { - "description": "Get SolidFire Account ID", - "isasync": false, - "name": "getSolidFireAccountId", - "params": [ { - "description": "CloudStack Account UUID", - "length": 255, - "name": "accountid", - "required": true, + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "Storage Pool UUID", - "length": 255, - "name": "storageid", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "SolidFire Account ID", - "name": "solidFireAccountId", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" - } - ] - }, - { - "description": "Lists role permissions", - "isasync": false, - "name": "listRolePermissions", - "params": [ - { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, - {}, { - "description": "the ID of the role permission", - "name": "id", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, - {}, { - "description": "the name of the role to which the role permission belongs", - "name": "rolename", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "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 bytes allocated", + "name": "virtualsize", + "type": "long" } - ], - "since": "4.9.0" + ] }, { - "description": "Lists all network services provided by CloudStack or for the given Provider.", - "isasync": false, - "name": "listSupportedNetworkServices", + "description": "Updates a project", + "isasync": true, + "name": "updateProject", "params": [ { - "description": "List by keyword", + "description": "new Admin account for the project", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "network service name to list providers and capabilities of", + "description": "ID of the user to be promoted/demoted", "length": 255, - "name": "service", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" + }, + { + "description": "name of the project", + "length": 255, + "name": "name", "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "", + "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": "pagesize", + "name": "swapowner", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "network service provider name", + "description": "id of the project to be modified", "length": 255, - "name": "provider", + "name": "id", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" + }, + { + "description": "display text of the project", + "length": 255, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "", + "description": "Account level role to be assigned to the user/account : Admin/Regular", "length": 255, - "name": "page", + "name": "roletype", "required": false, - "type": "integer" + "type": "string" } ], - "related": "", + "related": "activateProject,createProject,suspendProject", "response": [ { - "description": "the service provider name", - "name": "provider", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the name of the project", + "name": "name", + "type": "string" + }, + { + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the state of the project", + "name": "state", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + {}, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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 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 total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the list of resource tags associated with vm", + "name": "tags", "response": [ { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ + }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" - } - ], - "since": "3.0.0" - }, - { - "description": "Deletes a particular ingress rule from this security group", - "isasync": true, - "name": "revokeSecurityGroupIngress", - "params": [ - { - "description": "The ID of the ingress rule", - "length": 255, - "name": "id", - "related": "authorizeSecurityGroupIngress", - "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", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "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 total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" }, - {} - ] - }, - { - "description": "Lists dedicated guest vlan ranges", - "isasync": false, - "name": "listDedicatedGuestVlanRanges", - "params": [ { - "description": "list dedicated guest vlan ranges by id", - "length": 255, - "name": "id", - "related": "listDedicatedGuestVlanRanges", - "required": false, - "type": "uuid" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the dedicated guest vlan range", - "length": 255, - "name": "guestvlanrange", - "required": false, + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "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 date this project was created", + "name": "created", + "type": "date" }, { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "zone of the guest VLAN range", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" }, { - "description": "project who will own the guest VLAN range", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", "type": "integer" }, { - "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the physical network of the guest vlan range", - "name": "physicalnetworkid", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, + {}, { - "description": "the account of the guest VLAN range", - "name": "account", - "type": "string" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the project name of the guest vlan range", - "name": "project", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the zone of the guest vlan range", - "name": "zoneid", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, - {}, - {}, { - "description": "the domain name of the guest VLAN range", - "name": "domain", - "type": "string" - } - ] - }, - { - "description": "Adds a network serviceProvider to a physical network", - "isasync": true, - "name": "addNetworkServiceProvider", - "params": [ + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, { - "description": "the Physical Network ID to add the provider to", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the name for the physical network service provider", - "length": 255, - "name": "name", - "required": true, + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the list of services to be enabled for this physical network service provider", - "length": 255, - "name": "servicelist", - "required": false, - "type": "list" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the destination Physical Network ID to bridge to", - "length": 255, - "name": "destinationphysicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - } - ], - "related": "listNetworkServiceProviders,listTrafficTypes", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the total number of virtual machines running for this project", + "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 networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" }, - {}, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" } ], "since": "3.0.0" }, { - "description": "Lists all network ACL items", + "description": "Lists internal load balancers", "isasync": false, - "name": "listNetworkACLs", + "name": "listLoadBalancers", "params": [ { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the scheme of the load balancer. Supported value is internal in the current release", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "scheme", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list network ACL items by protocol", + "description": "the name of the load balancer", "length": 255, - "name": "protocol", + "name": "name", "required": false, "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isrecursive", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", @@ -50944,39 +49189,39 @@ "type": "boolean" }, { - "description": "", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "", + "description": "the ID of the load balancer", "length": 255, - "name": "page", + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list network ACL items by action", + "description": "List by keyword", "length": 255, - "name": "action", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Lists network ACL Item with the specified ID", + "description": "the source IP address of the load balancer", "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "name": "sourceipaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list network ACL items by ACL ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, @@ -50989,108 +49234,152 @@ "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the network ID of the source IP address", "length": 255, - "name": "account", + "name": "sourceipaddressnetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list network ACL items by traffic type - ingress or egress", + "description": "the network ID of the load balancer", "length": 255, - "name": "traffictype", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list network ACL items by network ID", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", + "related": "createLoadBalancer", "response": [ { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" + "description": "the name of the Load Balancer", + "name": "name", + "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the domain of the Load Balancer", + "name": "domain", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" + }, + { + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", "response": [ { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", + "response": [ + { + "description": "the name of the instance", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the state of the instance", + "name": "state", "type": "string" }, + { + "description": "the instance ID", + "name": "id", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", + "response": [ { "description": "id of the resource", "name": "resourceid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -51099,76 +49388,123 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the 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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" } ], "type": "list" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the Load Balancer", + "name": "project", "type": "string" }, + {}, + {}, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user", + "isasync": false, + "name": "registerUserKeys", + "params": [ + { + "description": "User id", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + } + ], + "related": "getUserKeys", + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "the api key of the registered user", + "name": "apikey", "type": "string" }, + {}, { - "description": "the state of the rule", - "name": "state", + "description": "the secret key of the registered user", + "name": "secretkey", "type": "string" - }, - {} + } ] }, { - "description": "Delete site to site vpn gateway", + "description": "Deletes a load balancer stickiness policy.", "isasync": true, - "name": "deleteVpnGateway", + "name": "deleteLBStickinessPolicy", "params": [ { - "description": "id of customer gateway", + "description": "the ID of the LB stickiness policy", "length": 255, "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", "required": true, "type": "uuid" } @@ -51184,494 +49520,480 @@ "name": "jobid", "type": "string" }, + {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] + }, + {} + ], + "since": "3.0.0" }, { - "description": "Creates a service offering.", + "description": "Lists site to site vpn connection gateways", "isasync": false, - "name": "createServiceOffering", + "name": "listVpnConnections", "params": [ { - "description": "max iops of the compute offering", + "description": "id of vpc", "length": 255, - "name": "maxiops", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "since": "4.4", - "type": "long" + "type": "uuid" }, { - "description": "is this a system vm offering", + "description": "", "length": 255, - "name": "issystem", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "systemvmtype", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the tags for this service offering.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "tags", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "burst bytes write rate of the disk offering", + "description": "List by keyword", "length": 255, - "name": "byteswriteratemax", + "name": "keyword", "required": false, - "type": "long" + "type": "string" }, { - "description": "bytes write rate of the disk offering", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "byteswriterate", + "name": "listall", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the Root disk size in GB.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "rootdisksize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.15", - "type": "long" + "type": "uuid" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "fordisplay", "required": false, "since": "4.4", - "type": "integer" - }, - { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "length": 255, - "name": "diskofferingstrictness", - "required": false, - "since": "4.17", "type": "boolean" }, { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", - "required": false, - "type": "long" - }, - { - "description": "length (in seconds) of the burst", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "bytesreadratemaxlength", + "name": "account", "required": false, - "type": "long" + "type": "string" }, { - "description": "the CPU speed of the service offering in MHz.", + "description": "", "length": 255, - "name": "cpuspeed", + "name": "page", "required": false, "type": "integer" }, { - "description": "The maximum number of CPUs to be set with Custom Computer Offering", + "description": "id of the vpn connection", "length": 255, - "name": "maxcpunumber", + "name": "id", + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "required": false, - "since": "4.13", - "type": "integer" + "type": "uuid" + } + ], + "related": "createVpnConnection,updateVpnConnection", + "response": [ + { + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" }, { - "description": "The display text of the service offering, defaults to 'name'.", - "length": 255, - "name": "displaytext", - "required": false, + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "length": 255, - "name": "iopswriteratemax", - "required": false, + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" }, { - "description": "VMs using this offering require root volume encryption", - "length": 255, - "name": "encryptroot", - "required": false, - "since": "4.18", - "type": "boolean" + "description": "the project name", + "name": "project", + "type": "string" }, { - "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": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "length": 255, - "name": "provisioningtype", - "required": false, + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "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", - "required": false, + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "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": "the domain id of the owner", + "name": "domainid", + "type": "string" }, + {}, { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "required": false, + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", "type": "long" }, { - "description": "the total memory of the service offering in MB", - "length": 255, - "name": "memory", - "required": false, - "type": "integer" + "description": "the connection ID", + "name": "id", + "type": "string" }, { - "description": "restrict the CPU usage to committed service offering", - "length": 255, - "name": "limitcpuuse", - "required": false, + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, { - "description": "details for planner, used to store specific parameters", - "length": 255, - "name": "serviceofferingdetails", - "required": false, - "type": "map" + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" }, { - "description": "the host tag for this service offering.", - "length": 255, - "name": "hosttags", - "required": false, + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "whether compute offering iops is custom or not", - "length": 255, - "name": "customizediops", - "required": false, - "since": "4.4", + "description": "is connection for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "The minimum memory size of the custom service offering in MB", - "length": 255, - "name": "minmemory", - "required": false, - "since": "4.13", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Whether service offering size is custom or not", - "length": 255, - "name": "customized", - "required": false, - "since": "4.13", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the service offering", - "length": 255, - "name": "name", - "required": true, + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "min iops of the compute offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.4", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "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": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, { - "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": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" }, { - "description": "the storage type of the service offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "length": 255, - "name": "cachemode", - "required": false, - "since": "4.14", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "type": "long" + "description": "the domain path of the owner", + "name": "domainpath", + "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": "the owner", + "name": "account", + "type": "string" }, { - "description": "the HA for the service offering", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" + } + ] + }, + { + "description": "remove Tungsten-Fabric policy", + "isasync": true, + "name": "removeTungstenFabricPolicy", + "params": [ + { + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "offerha", - "required": false, - "type": "boolean" + "name": "policyuuid", + "required": true, + "type": "string" }, { - "description": "io requests write rate of the disk offering", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "iopswriterate", - "required": false, - "type": "long" + "name": "networkuuid", + "required": true, + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "the ID of zone", "length": 255, - "name": "iopsreadratemaxlength", - "required": false, - "type": "long" + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "createTungstenFabricPolicy,listTungstenFabricPolicy,applyTungstenFabricPolicy", + "response": [ + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, + {}, { - "description": "the CPU number of the service offering", - "length": 255, - "name": "cpunumber", - "required": false, - "type": "integer" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, + {}, { - "description": "the ID of the disk offering to which service offering should be mapped", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the containing zone(s), null for public offerings", - "length": 255, + "description": "Tungsten-Fabric provider zone id", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "list" + "type": "long" }, { - "description": "burst requests read rate of the disk offering", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, + {} + ] + }, + { + "description": "Migrate current NFS secondary storages to use object store.", + "isasync": false, + "name": "updateCloudToUseObjectStore", + "params": [ + { + "description": "the URL for the image store", "length": 255, - "name": "iopsreadratemax", + "name": "url", "required": false, - "type": "long" + "type": "string" }, { - "description": "burst bytes read rate of the disk offering", + "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": "bytesreadratemax", + "name": "details", "required": false, - "type": "long" + "type": "map" }, { - "description": "The maximum memory size of the custom service offering in MB", + "description": "the image store provider name", "length": 255, - "name": "maxmemory", - "required": false, - "since": "4.13", - "type": "integer" + "name": "provider", + "required": true, + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "the name for the image store", "length": 255, - "name": "byteswriteratemaxlength", + "name": "name", "required": false, - "type": "long" + "type": "string" } ], - "related": "updateServiceOffering,listServiceOfferings", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", "response": [ { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", - "name": "isvolatile", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", - "type": "string" - }, - { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, - {}, - {}, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "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": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the service 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": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, + {}, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "the name of the image store", + "name": "name", + "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "the ID of the image store", + "name": "id", "type": "string" }, + {} + ], + "since": "4.3.0" + }, + { + "description": "Creates a range of Autonomous Systems for BGP Dynamic Routing", + "isasync": false, + "name": "createASNRange", + "params": [ + { + "description": "the start AS Number", + "length": 255, + "name": "startasn", + "required": true, + "type": "long" + }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "the end AS Number", + "length": 255, + "name": "endasn", + "required": true, "type": "long" - }, + } + ], + "related": "listASNRanges", + "response": [ { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" + "description": "Created date", + "name": "created", + "type": "date" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "End AS Number", + "name": "endasn", "type": "long" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "Zone ID", + "name": "zoneid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -51679,49 +50001,71 @@ "type": "integer" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" + "description": "ID of the AS Number Range", + "name": "id", + "type": "string" }, + {}, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "Start AS Number", + "name": "startasn", "type": "long" }, + {}, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" - }, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "add Tungsten-Fabric network gateway to logical router", + "isasync": true, + "name": "addTungstenFabricNetworkGatewayToLogicalRouter", + "params": [ { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "Tungsten-Fabric logical router uuid", + "length": 255, + "name": "logicalrouteruuid", + "required": true, + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "Tungsten-Fabric network uuid", + "length": 255, + "name": "networkuuid", + "required": true, "type": "string" - }, + } + ], + "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter,listTungstenFabricLogicalRouter", + "response": [ { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "Tungsten-Fabric logical router name", + "name": "name", + "type": "string" }, + {}, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" }, + {}, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "name": "hypervisorsnapshotreserve", - "type": "integer" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { "description": "the UUID of the latest async job acting on this object", @@ -51729,256 +50073,402 @@ "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" - }, - { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "description": "Tungsten-Fabric provider zone id", "name": "zoneid", - "type": "string" + "type": "long" }, { - "description": "the memory in MB", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" + } + ] + }, + { + "description": "list Tungsten-Fabric nic", + "isasync": false, + "name": "listTungstenFabricNic", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the uuid of Tungsten-Fabric nic", + "length": 255, + "name": "nicuuid", + "required": false, "type": "string" }, { - "description": "the number of CPU", - "name": "cpunumber", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "Tungsten-Fabric nic uuid", + "name": "uuid", + "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "Tungsten-Fabric nic name", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Retrieves VMware DC(s) associated with a zone.", + "isasync": false, + "name": "listVmwareDcs", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the name of the service offering", - "name": "name", + "description": "Id of the CloudStack zone.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "addVmwareDc", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The VMware Datacenter ID", + "name": "id", + "type": "string" }, { - "description": "the id of the service offering", - "name": "id", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, + {}, + {}, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "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": "Copies a template from one zone to another.", + "description": "apply Tungsten-Fabric policy", "isasync": true, - "name": "copyTemplate", + "name": "applyTungstenFabricPolicy", "params": [ { - "description": "A list of IDs of the zones that the template needs to be copied to.Specify this list if the template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "description": "the uuid of network", "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" + "name": "networkuuid", + "required": true, + "type": "string" }, { - "description": "ID of the zone the template is currently hosted on. If not specified and template is cross-zone, then we will sync this template to region wide image store.", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "sourcezoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "name": "policyuuid", + "required": true, + "type": "string" }, { - "description": "ID of the zone the template is being copied to.", + "description": "the minor sequence of Tungsten-Fabric policy", "length": 255, - "name": "destzoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "name": "minorsequence", + "required": true, + "type": "integer" }, { - "description": "Template ID.", + "description": "the major sequence of Tungsten-Fabric policy", "length": 255, - "name": "id", - "related": "listIsos,registerIso,copyTemplate,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "majorsequence", + "required": true, + "type": "integer" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, "type": "uuid" } ], - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "createTungstenFabricPolicy,listTungstenFabricPolicy", "response": [ + {}, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, + { + "description": "Tungsten-Fabric policy name", + "name": "name", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, + {}, { - "description": "checksum of the template", - "name": "checksum", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Lists zones", + "isasync": false, + "name": "listZones", + "params": [ + { + "description": "the network type of the zone that the virtual machine belongs to", + "length": 255, + "name": "networktype", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "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": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the ID of the domain associated with the zone", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the name of the zone", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "flag to display the capacity of the zones", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "List zones by resource tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "since": "4.3", + "type": "map" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "flag to display the resource image for the zones", + "length": 255, + "name": "showicon", + "required": false, "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "the ID of the zone", + "length": 255, + "name": "id", + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the IDs of the zones, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "createZone,listZones,listZones", + "required": false, + "since": "4.19.0", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createZone,listZones", + "response": [ + { + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" }, - {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "Zone description", + "name": "description", + "type": "string" }, + {}, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, + {}, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", "type": "map" }, { @@ -51987,97 +50477,154 @@ "type": "resourceiconresponse" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the status of the template", - "name": "status", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", "type": "boolean" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the capacity of the Zone", + "name": "capacity", + "response": [ + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "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 percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + } + ], + "type": "list" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "the template name", - "name": "name", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with zone.", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -52086,124 +50633,224 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the 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 project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" }, - {}, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Zone Token", + "name": "zonetoken", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" + }, + { + "description": "Network domain name for the networks in the zone", + "name": "domain", + "type": "string" + }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the date this template was created", + "description": "the type of the zone - core or edge", + "name": "type", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" + } + ] + }, + { + "description": "Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.", + "isasync": false, + "name": "removeQuarantinedIp", + "params": [ + { + "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "The reason for removing the public IP address from quarantine prematurely.", + "length": 255, + "name": "removalreason", + "required": true, + "type": "string" + }, + { + "description": "The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "id", + "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", + "required": false, + "type": "uuid" + } + ], + "related": "listQuarantinedIps,updateQuarantinedIp", + "response": [ + { + "description": "ID of the quarantine process.", + "name": "id", + "type": "string" + }, + { + "description": "The public IP address in quarantine.", + "name": "ipaddress", + "type": "string" + }, + {}, + {}, + { + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", + "type": "string" + }, + { + "description": "When the quarantine was created.", "name": "created", "type": "date" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.19" }, { - "description": "lists network that are using a nicira nvp device", + "description": "Releases a Public IP range back to the system pool", "isasync": false, - "name": "listNiciraNvpDeviceNetworks", + "name": "releasePublicIpRange", "params": [ { - "description": "nicira nvp device ID", + "description": "the id of the Public IP range", "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "required": true, "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "lists network that are using a netscaler load balancer device", + "isasync": false, + "name": "listNetscalerLoadBalancerNetworks", + "params": [ { "description": "List by keyword", "length": 255, @@ -52211,439 +50858,529 @@ "required": false, "type": "string" }, + { + "description": "netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "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": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the list of services", - "name": "service", + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", "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 project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "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": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - } - ], - "type": "list" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the service name", - "name": "name", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, + {}, + {}, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, { "description": "the total number of network traffic bytes sent", "name": "sentbytes", "type": "long" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the 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 date this network was created", + "name": "created", + "type": "date" }, { - "description": "the name of the network", - "name": "name", + "description": "VPC the network belongs to", + "name": "vpcid", "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 network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the list of resource tags associated with network", - "name": "tags", + "description": "the list of services", + "name": "service", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "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": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + } + ], + "type": "list" } ], "type": "list" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "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": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { @@ -52652,1053 +51389,570 @@ "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + } + ] + }, + { + "description": "create Tungsten-Fabric public network", + "isasync": false, + "name": "createTungstenFabricPublicNetwork", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true if operation is executed successfully", + "name": "success", "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": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ] + }, + { + "description": "Lists supported methods of network isolation", + "isasync": false, + "name": "listNetworkIsolationMethods", + "params": [ { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "Network isolation method name", + "name": "name", + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.2.0" + }, + { + "description": "Lists host HA resources", + "isasync": false, + "name": "listHostHAResources", + "params": [ + { + "description": "List by host ID", + "length": 255, + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": false, + "type": "uuid" + } + ], + "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", + "response": [ + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" + }, + { + "description": "operation status", + "name": "status", "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, {}, + {}, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - {} - ] + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.11" }, { - "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", + "description": "list Tungsten-Fabric firewall policy", "isasync": false, - "name": "assignVirtualMachine", + "name": "listTungstenFabricFirewallPolicy", "params": [ { - "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "networkids", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "firewallpolicyuuid", "required": false, - "type": "list" + "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.", + "description": "", "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "account name of the new VM owner.", + "description": "the ID of zone", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "domain id of the new VM owner.", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "id of the VM to be moved", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "virtualmachineid", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "applicationpolicysetuuid", + "required": false, + "type": "string" }, { - "description": "an optional project for the new VM owner.", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "createTungstenFabricFirewallPolicy", "response": [ { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Tungsten-Fabric firewall policy name", + "name": "name", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", "type": "string" }, + {}, + {}, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Deletes a specified domain", + "isasync": true, + "name": "deleteDomain", + "params": [ + { + "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, "type": "boolean" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "ID of domain to delete", + "length": 255, + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain name of the affinity group", - "name": "domain", - "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 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": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ] + }, + { + "description": "Migrate volume", + "isasync": true, + "name": "migrateVolume", + "params": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the volume", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "if the volume should be live migrated when it is attached to a running vm", + "length": 255, + "name": "livemigrate", + "required": false, + "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "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", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "destination storage pool ID to migrate the volume to", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + } + ], + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "response": [ + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - } - ], - "type": "set" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "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 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" - }, - { - "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": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the 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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "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 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "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" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the 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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "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 description of the security group", - "name": "description", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "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 VM's disk read in KiB", - "name": "diskkbsread", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the bytes allocated", + "name": "virtualsize", "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", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, - {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the ID of the 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": "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", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "ID of the disk volume", "name": "id", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { @@ -53707,787 +51961,525 @@ "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists virtual machines on a unmanaged host", - "isasync": false, - "name": "listVmsForImport", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" }, { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the username for the host", - "length": 255, - "name": "username", - "required": false, - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the host name or IP address", - "length": 255, - "name": "host", - "required": true, - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, + {}, { - "description": "the password for the host", - "length": 255, - "name": "password", - "required": false, - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - } - ], - "related": "listVmwareDcVms,listUnmanagedInstances", - "response": [ - { - "description": "the list of nics associated with the virtual machine", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the memory of the virtual machine in MB", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" - }, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + } + ], + "since": "3.0.0" + }, + { + "description": "create Tungsten-Fabric application policy set", + "isasync": true, + "name": "createTungstenFabricApplicationPolicySet", + "params": [ { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "Tungsten-Fabric application policy set name", + "length": 255, + "name": "name", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the name of the virtual machine", + "description": "Tungsten-Fabric policy name", "name": "name", "type": "string" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ - { - "description": "the ID of the disk", - "name": "id", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastoretype", - "type": "string" - }, - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "controller", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorename", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" - }, - { - "description": "the file path of the disk image", - "name": "imagepath", - "type": "string" - }, - { - "description": "the label of the disk", - "name": "label", - "type": "string" - }, - { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - } - ], - "type": "set" + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" }, + {}, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", "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 ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "type": "string" + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" }, { - "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 operating system ID of the virtual machine", - "name": "osid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, - {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, {} - ], - "since": "4.19.0" + ] }, { - "description": " delete a BigSwitch BCF Controller device", + "description": "Deletes an existing Bgp Peer.", "isasync": true, - "name": "deleteBigSwitchBcfDevice", + "name": "deleteBgpPeer", "params": [ { - "description": "BigSwitch device ID", + "description": "Id of the Bgp Peer", "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", + "name": "id", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", "required": true, "type": "uuid" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], - "since": "4.6.0" + "since": "4.20.0" }, { - "description": "configures a netscaler load balancer device", - "isasync": true, - "name": "configureNetscalerLoadBalancer", + "description": "A command to list events.", + "isasync": false, + "name": "listEvents", "params": [ { - "description": "true if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts", + "description": "the time the event was entered", "length": 255, - "name": "lbdevicededicated", + "name": "entrytime", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "description": "the event level (INFO, WARN, ERROR)", "length": 255, - "name": "podids", - "related": "updatePod,createManagementNetworkIpRange", + "name": "level", "required": false, - "type": "list" + "type": "string" }, { - "description": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", + "description": "List by keyword", "length": 255, - "name": "inline", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", + "description": "the ID of the event", "length": 255, - "name": "lbdevicecapacity", + "name": "id", + "related": "listEvents", "required": false, - "type": "long" - }, - { - "description": "Netscaler load balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, "type": "uuid" - } - ], - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "response": [ - { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, - {}, - { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" - }, - { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "type": "string" - }, - { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", - "type": "string" - }, - { - "description": "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": "name of the provider", - "name": "provider", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the duration of the event", + "length": 255, + "name": "duration", + "required": false, "type": "integer" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true to list archived events otherwise false", + "length": 255, + "name": "archived", + "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" - }, - { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "device state", - "name": "lbdevicestate", - "type": "string" - }, - { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "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": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the type of the resource associated with the event", + "length": 255, + "name": "resourcetype", + "required": false, + "since": "4.17.0", "type": "string" }, - {} - ] - }, - { - "description": "Lists all available ovs elements.", - "isasync": false, - "name": "listOvsElements", - "params": [ { - "description": "list network offerings by enabled state", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "enabled", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "list ovs elements by id", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "listOvsElements,configureOvsElement", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "the event type (see event types)", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list ovs elements by network service provider id", + "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": "nspid", - "related": "listNetworkServiceProviders,listTrafficTypes", + "name": "startid", + "related": "listEvents", "required": false, "type": "uuid" + }, + { + "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "the ID of the resource associated with the event", + "length": 255, + "name": "resourceid", + "required": false, + "since": "4.17.0", + "type": "string" } ], - "related": "configureOvsElement", + "related": "", "response": [ { - "description": "the id of the ovs", - "name": "id", + "description": "the name of the account's domain", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the resource", + "name": "resourcename", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "whether the event has been archived or not", + "name": "archived", + "type": "boolean" + }, + { + "description": "a brief description of the event", + "name": "description", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the id of the resource", + "name": "resourceid", "type": "string" }, - {}, - {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "whether the event is parented", + "name": "parentid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date the event was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the address", - "name": "project", + "description": "path of the Domain the account's domain belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)", + "name": "username", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the domain ID associated with the provider", + "description": "the id of the account's domain", "name": "domainid", "type": "string" - } - ] - }, - { - "description": "delete Tungsten-Fabric service group", - "isasync": true, - "name": "deleteTungstenFabricServiceGroup", - "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" }, + {}, { - "description": "the uuid of Tungsten-Fabric service group", - "length": 255, - "name": "servicegroupuuid", - "required": true, + "description": "the event level (INFO, WARN, ERROR)", + "name": "level", "type": "string" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the type of the resource", + "name": "resourcetype", "type": "string" }, { @@ -54495,7 +52487,16 @@ "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "the state of the event", + "name": "state", + "type": "state" + }, + { + "description": "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", + "name": "account", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -54503,155 +52504,124 @@ }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the event", + "name": "id", + "type": "string" + }, + { + "description": "the type of the event (see event types)", + "name": "type", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" } ] }, { - "description": "associate a profile to a blade", - "isasync": true, - "name": "associateUcsProfileToBlade", + "description": "Lists HA providers", + "isasync": false, + "name": "listHostHAProviders", "params": [ { - "description": "profile dn", + "description": "Hypervisor type of the resource", "length": 255, - "name": "profiledn", + "name": "hypervisor", "required": true, "type": "string" - }, - { - "description": "ucs manager id", - "length": 255, - "name": "ucsmanagerid", - "related": "listUcsManagers,addUcsManager", - "required": true, - "type": "uuid" - }, - { - "description": "blade id", - "length": 255, - "name": "bladeid", - "related": "associateUcsProfileToBlade", - "required": true, - "type": "uuid" } ], - "related": "", + "related": "configureHAForHost,enableHAForHost,disableHAForHost", "response": [ { - "description": "cloudstack host id this blade associates to", - "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": "ucs blade dn", - "name": "bladedn", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "associated ucs profile dn", - "name": "profiledn", + "description": "operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "ucs manager id", - "name": "ucsmanagerid", - "type": "string" - }, { - "description": "ucs blade id", - "name": "id", - "type": "string" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" } - ] + ], + "since": "4.11" }, { - "description": "Adds a object storage pool", - "isasync": false, - "name": "addObjectStoragePool", + "description": "Creates resource tag(s)", + "isasync": true, + "name": "createTags", "params": [ { - "description": "the tags for the storage pool", - "length": 255, - "name": "tags", - "required": false, - "type": "string" - }, - { - "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "description": "list of resources to create the tags for", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "resourceids", + "required": true, + "type": "list" }, { - "description": "the name for the object store", + "description": "type of the resource", "length": 255, - "name": "name", + "name": "resourcetype", "required": true, "type": "string" }, { - "description": "the URL for the object store", - "length": 2048, - "name": "url", + "description": "Map of tags (key/value pairs)", + "length": 255, + "name": "tags", "required": true, - "type": "string" + "type": "map" }, { - "description": "the object store provider name", + "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", "length": 255, - "name": "provider", - "required": true, + "name": "customer", + "required": false, "type": "string" } ], - "related": "", "response": [ + {}, + {}, { - "description": "the name of the object store", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the object store", - "name": "id", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, - { - "description": "the object store currently used size", - "name": "storageused", - "type": "long" - }, - { - "description": "the url of the object store", - "name": "url", - "type": "string" - }, - { - "description": "the total size of the object store", - "name": "storagetotal", - "type": "long" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -54661,212 +52631,177 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "the provider name of the object store", - "name": "providername", - "type": "string" - }, - {} + } ], - "since": "4.19.0" + "since": "4.0.0" }, { - "description": "Deletes user from the project", + "description": "Create an Internal Load Balancer element.", "isasync": true, - "name": "deleteUserFromProject", + "name": "createInternalLoadBalancerElement", "params": [ { - "description": "ID of the project to remove the user from", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "description": "Id of the user to be removed from the project", + "description": "the network service provider ID of the internal load balancer element", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": true, "type": "uuid" } ], + "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "response": [ { - "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the physical network service provider id of the element", + "name": "nspid", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation 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 id of the internal load balancer element", + "name": "id", + "type": "string" + } ], - "since": "4.15.0" + "since": "4.2.0" }, { - "description": "Updates a VMware datacenter details for a zone", + "description": "Reset api count", "isasync": false, - "name": "updateVmwareDc", + "name": "resetApiLimit", "params": [ { - "description": "The username required to connect to resource.", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, - { - "description": "VMware datacenter name.", + "description": "the ID of the account whose limit to be reset", "length": 255, - "name": "name", + "name": "account", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "string" - }, - { - "description": "The zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, "type": "uuid" - }, - { - "description": "Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "The password for specified username.", - "length": 255, - "name": "password", - "required": false, - "type": "string" - }, - { - "description": "The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", - "length": 255, - "name": "vcenter", - "required": false, - "type": "string" } ], - "related": "addVmwareDc,listVmwareDcs", "response": [ + {}, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "the UUID 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 VMware Datacenter name", - "name": "name", + "description": "any text associated with the 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 VMware vCenter name/ip", - "name": "vcenter", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" } - ], - "since": "4.12.0" + ] }, { - "description": "Checks the 2FA code for the user.", + "description": "Deletes a VLAN IP range.", "isasync": false, - "name": "validateUserTwoFactorAuthenticationCode", + "name": "deleteVlanIpRange", "params": [ { - "description": "two factor authentication code", + "description": "the id of the VLAN IP range", "length": 255, - "name": "codefor2fa", + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "required": true, - "type": "string" + "type": "uuid" } ], "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } - ], - "since": "4.18.0" + ] }, { - "description": "Starts a router.", - "isasync": false, - "name": "getRouterHealthCheckResults", + "description": "Generates an alert", + "isasync": true, + "name": "generateAlert", "params": [ { - "description": "the ID of the router", + "description": "Alert description", + "length": 999, + "name": "description", + "required": true, + "type": "string" + }, + { + "description": "Name of the alert", "length": 255, - "name": "routerid", - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "name": "name", "required": true, + "type": "string" + }, + { + "description": "Type of the alert", + "length": 255, + "name": "type", + "required": true, + "type": "short" + }, + { + "description": "Pod id for which alert is generated", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, "type": "uuid" }, { - "description": "if true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched", + "description": "Zone id for which alert is generated", "length": 255, - "name": "performfreshchecks", + "name": "zoneid", + "related": "createZone,listZones", "required": false, - "type": "boolean" + "type": "uuid" } ], - "related": "", "response": [ { "description": "the UUID of the latest async job acting on this object", @@ -54878,154 +52813,112 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the id of the router", - "name": "routerid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, { - "description": "the id of the router", - "name": "healthchecks", - "type": "list" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} ], - "since": "4.14.0" + "since": "4.3" }, { - "description": "list control center", + "description": "(Deprecated, use addLdapConfiguration) Configure the LDAP context for this site.", "isasync": false, - "name": "listNetscalerControlCenter", + "name": "ldapConfig", "params": [ { - "description": "List by keyword", + "description": "Enter the path to trust certificates store.", "length": 255, - "name": "keyword", + "name": "truststore", "required": false, "type": "string" }, { - "description": "", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", "length": 255, - "name": "pagesize", + "name": "hostname", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "Specify the LDAP port if required, default is 389.", "length": 255, - "name": "page", + "name": "port", "required": false, "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "ncc_ip", - "name": "ipaddress", - "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "If true return current LDAP configuration", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "id", - "name": "id", - "type": "string" - }, - { - "description": "uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "num_retries", - "name": "numretries", - "type": "string" - }, - { - "description": "username", - "name": "username", - "type": "string" - }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Resizes a volume", - "isasync": true, - "name": "resizeVolume", - "params": [ - { - "description": "New maximum number of IOPS", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", "length": 255, - "name": "maxiops", + "name": "searchbase", "required": false, - "type": "long" + "type": "string" }, { - "description": "Verify OK to Shrink", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "shrinkok", + "name": "queryfilter", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "New volume size in GB", + "description": "Specify the distinguished name of a user with the search permission on the directory.", "length": 255, - "name": "size", + "name": "binddn", "required": false, - "type": "long" + "type": "string" }, { - "description": "new disk offering id", + "description": "Enter the password for trust store.", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "truststorepass", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "New minimum number of IOPS", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", "length": 255, - "name": "miniops", + "name": "ssl", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the ID of the disk volume", + "description": "Enter the password.", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,resizeVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "name": "bindpass", + "required": false, + "type": "string" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "ldapRemove", "response": [ { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "Specify the LDAP port if required, default is 389", + "name": "port", "type": "string" }, { @@ -55034,304 +52927,442 @@ "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", + "name": "searchbase", "type": "string" }, + {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "DN password", + "name": "bindpass", + "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, + {} + ], + "since": "3.0.0" + }, + { + "description": "List vSphere storage policies", + "isasync": false, + "name": "listVsphereStoragePolicies", + "params": [ { - "description": "the account associated with the disk volume", - "name": "account", + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the status of the volume", - "name": "status", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the description of the Storage Policy", + "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the name of the Storage Policy", + "name": "name", "type": "string" }, + {}, + {} + ] + }, + { + "description": "Deletes a port forwarding rule", + "isasync": true, + "name": "deletePortForwardingRule", + "params": [ { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the ID of the port forwarding rule", + "length": 255, + "name": "id", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "moves a vpc to another physical network", + "isasync": true, + "name": "migrateVPC", + "params": [ + { + "description": "true if previous network migration cmd failed", + "length": 255, + "name": "resume", + "required": false, + "type": "boolean" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the ID of the vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", + "length": 255, + "name": "tiernetworkofferings", + "required": false, + "type": "map" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "vpc offering ID", + "length": 255, + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, + "type": "uuid" + } + ], + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "response": [ + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the project name of the VPC", + "name": "project", "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": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "name of the availability zone", + "description": "the name of the zone the VPC belongs to", "name": "zonename", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", + "description": "the date this VPC was created", + "name": "created", "type": "date" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "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": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, - {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "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": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -55340,18 +53371,18 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -55360,106 +53391,51 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], - "type": "set" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "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" + "type": "list" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if VPC is region level", + "name": "regionlevelvpc", "type": "boolean" } - ] + ], + "since": "4.11.0" }, { - "description": "Deletes affinity group", + "description": "Deletes a global load balancer rule.", "isasync": true, - "name": "deleteAffinityGroup", + "name": "deleteGlobalLoadBalancerRule", "params": [ { - "description": "the account of the affinity group. Must be specified with domain ID", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "the domain ID of account owning the affinity group", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "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" - }, - { - "description": "The name of the affinity group. Mutually exclusive with ID parameter", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "description": "the ID of the global load balancer rule", "length": 255, "name": "id", - "related": "", - "required": false, + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "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", @@ -55467,283 +53443,292 @@ }, {}, { - "description": "the current status of the latest async job acting 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": "Deletes a network offering.", + "description": "update an annotation visibility.", "isasync": false, - "name": "deleteNetworkOffering", + "name": "updateAnnotationVisibility", "params": [ { - "description": "the ID of the network offering", + "description": "the annotation is visible for admins only", + "length": 255, + "name": "adminsonly", + "required": true, + "type": "boolean" + }, + { + "description": "the id of the annotation", "length": 255, "name": "id", - "related": "listNetworkOfferings", "required": true, - "type": "uuid" + "type": "string" } ], + "related": "addAnnotation,listAnnotations,removeAnnotation", "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" + }, + { + "description": "the (uu)id of the annotation", + "name": "id", + "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "since": "3.0.0" - }, - { - "description": "Deletes a Network Service Provider.", - "isasync": true, - "name": "deleteNetworkServiceProvider", - "params": [ + }, + {}, { - "description": "the ID of the network service provider", - "length": 255, - "name": "id", - "related": "listNetworkServiceProviders,listTrafficTypes", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation 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 (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" + } ], - "since": "3.0.0" + "since": "4.16" }, { - "description": "Dedicates a Pod.", - "isasync": true, - "name": "dedicatePod", + "description": "Updates a configuration.", + "isasync": false, + "name": "updateConfiguration", "params": [ { - "description": "the ID of the Pod", + "description": "the name of the configuration", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "name", "required": true, + "type": "string" + }, + { + "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "length": 255, + "name": "imagestoreuuid", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", + "required": false, "type": "uuid" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "the value of the configuration", + "length": 4096, + "name": "value", "required": false, "type": "string" }, { - "description": "the ID of the containing domain", + "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": "the ID of the Domain to update the parameter value for corresponding domain", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": true, + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Account to update the parameter value for corresponding account", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, "type": "uuid" } ], - "related": "listDedicatedPods", + "related": "listConfigurations", "response": [ - {}, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "description": "the component of the configuration", + "name": "component", "type": "string" }, { - "description": "the ID of the Pod", - "name": "podid", + "description": "the category of the configuration", + "name": "category", + "type": "string" + }, + { + "description": "the value of the configuration", + "name": "value", "type": "string" }, {}, + { + "description": "the display text of the configuration", + "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 Name of the Pod", - "name": "podname", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group of the configuration", + "name": "group", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the name of the configuration", + "name": "name", "type": "string" - } - ] - }, - { - "description": "List network devices", - "isasync": false, - "name": "listNetworkDevice", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", - "length": 255, - "name": "networkdevicetype", - "required": false, + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "parameters for network device", - "length": 255, - "name": "networkdeviceparameterlist", - "required": false, - "type": "map" + "description": "the description of the configuration", + "name": "description", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "addNetworkDevice", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" }, { - "description": "the ID of the network device", + "description": "the value of the configuration", "name": "id", - "type": "string" - } + "type": "long" + }, + {} ] }, { - "description": "Update a Storage network IP range, only allowed when no IPs in this range have been allocated.", + "description": "Configures HA for a host", "isasync": true, - "name": "updateStorageNetworkIpRange", + "name": "configureHAForHost", "params": [ { - "description": "the beginning IP address", - "length": 255, - "name": "startip", - "required": false, - "type": "string" - }, - { - "description": "the ending IP address", + "description": "HA provider", "length": 255, - "name": "endip", - "required": false, + "name": "provider", + "required": true, "type": "string" }, { - "description": "UUID of storage network ip range", + "description": "ID of the host", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, "type": "uuid" - }, - { - "description": "the netmask for storage network", - "length": 255, - "name": "netmask", - "required": false, - "type": "string" - }, - { - "description": "Optional. the vlan the ip range sits on", - "length": 255, - "name": "vlan", - "required": false, - "type": "integer" } ], - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "related": "enableHAForHost,disableHAForHost", "response": [ - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -55751,66 +53736,58 @@ }, {}, { - "description": "the uuid of storage network IP range.", - "name": "id", - "type": "string" - }, - { - "description": "the end ip of the storage network IP range", - "name": "endip", - "type": "string" - }, - { - "description": "the gateway of the storage network IP range", - "name": "gateway", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, - {}, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", - "type": "string" + "description": "operation status", + "name": "status", + "type": "boolean" }, { - "description": "the network uuid of storage network IP range", - "name": "networkid", - "type": "string" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], - "since": "3.0.0" + "since": "4.11" }, { - "description": "Lists Project roles in CloudStack", + "description": "Lists volume stats", "isasync": false, - "name": "listProjectRoles", + "name": "listVolumesUsageHistory", "params": [ { - "description": "List project role by project ID.", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": true, - "type": "uuid" + "name": "enddate", + "required": false, + "type": "date" + }, + { + "description": "the IDs of the volumes, mutually exclusive with id.", + "length": 255, + "name": "ids", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": false, + "type": "list" }, { "description": "", @@ -55820,286 +53797,147 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List project role by project role ID.", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "projectroleid", - "related": "createProjectRole,listProjectRoles,updateProjectRole", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "", + "description": "the ID of the volume.", "length": 255, - "name": "page", + "name": "id", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List project role by project role name.", + "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", "length": 255, "name": "name", "required": false, "type": "string" - } - ], - "related": "createProjectRole,updateProjectRole", - "response": [ + }, { - "description": "the ID of the role", - "name": "id", - "type": "string" - }, - {}, - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the 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", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} - ], - "since": "4.15.0" - }, - { - "description": "Removes an OpenDaylight controller", - "isasync": true, - "name": "deleteOpenDaylightController", - "params": [ - { - "description": "OpenDaylight Controller ID", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" } ], - "related": "addOpenDaylightController", + "related": "", "response": [ { - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the ID of the volume", + "name": "id", "type": "string" }, + {}, { - "description": "the url of the controller api", - "name": "url", - "type": "string" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, {}, { - "description": "the name assigned to the controller", + "description": "the name of the volume", "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "device id of the controller", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.18.0" }, { - "description": "Updates attributes of a template.", + "description": "Dedicates a Public IP range to an account", "isasync": false, - "name": "updateTemplate", + "name": "dedicatePublicIpRange", "params": [ { - "description": "sort key of the template, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, - { - "description": "true if the image supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "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 format for the image", - "length": 255, - "name": "format", - "required": false, - "type": "string" - }, - { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" - }, - { - "description": "true if the template type is routing i.e., if template is used to deploy router", - "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" - }, - { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" - }, - { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "account who will own the VLAN", "length": 255, - "name": "templatetype", + "name": "account", "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", - "required": false, - "type": "map" - }, - { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" - }, - { - "description": "true if image is bootable, false otherwise; available only for updateIso API", - "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" - }, - { - "description": "the name of the image file", + "description": "project who will own the VLAN", "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the OS type that best represents the OS of this image.", + "description": "the id of the VLAN IP range", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", + "required": true, "type": "uuid" }, { - "description": "the ID of the image file", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" } ], - "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "createVlanIpRange,updateVlanIpRange", "response": [ { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", + "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -56107,688 +53945,660 @@ "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the cidr of the VLAN IP range", + "name": "cidr", + "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the start ip of the VLAN IP range", + "name": "startip", + "type": "string" }, { - "description": "the template ID", + "description": "the ID of the VLAN IP range", "name": "id", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "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": "checksum of the template", - "name": "checksum", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the account of the VLAN IP range", + "name": "account", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, - {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", "type": "boolean" }, - {}, { - "description": "the template display text", - "name": "displaytext", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, + {} + ] + }, + { + "description": "Deletes an empty Bucket.", + "isasync": false, + "name": "deleteBucket", + "params": [ { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, + "description": "The ID of the Bucket", + "length": 255, + "name": "id", + "related": "createBucket,listBuckets", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "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 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": "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 project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.19.0" + }, + { + "description": "Adds API permissions to a project role", + "isasync": false, + "name": "createProjectRolePermission", + "params": [ { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "The API name or wildcard rule such as list*", + "length": 255, + "name": "rule", + "required": true, + "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "ID of project where project role permission is to be created", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" }, { - "description": "the project name of the template", - "name": "project", + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The description of the role permission", + "length": 255, + "name": "description", + "required": false, + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": true, + "type": "uuid" + } + ], + "related": "listProjectRolePermissions", + "response": [ + {}, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the project role permission", + "name": "id", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the ID of the project", + "name": "projectid", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.15.0" }, { - "description": "Creates a VLAN IP range.", + "description": "Create a console endpoint to connect to a VM console", "isasync": false, - "name": "createVlanIpRange", + "name": "createConsoleEndpoint", "params": [ { - "description": "true if VLAN is of Virtual type, false if Direct", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" - }, - { - "description": "domain ID of the account owning a VLAN", + "description": "ID of the VM", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, + "name": "virtualmachineid", + "related": "assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "required": true, "type": "uuid" }, { - "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "description": "(optional) extra security token, valid when the extra validation is enabled", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "token", "required": false, - "type": "uuid" - }, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, + "description": "details in case of an error", + "name": "details", "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", - "length": 255, - "name": "startipv6", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "true if the console endpoint is generated properly", + "name": "success", + "type": "boolean" }, { - "description": "the gateway of the VLAN IP range", - "length": 255, - "name": "gateway", - "required": false, + "description": "the console websocket options", + "name": "websocket", + "type": "consoleendpointwebsocketresponse" + }, + { + "description": "the console url", + "name": "url", "type": "string" }, + {}, + {}, { - "description": "the network id", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.18.0" + }, + { + "description": "Updates a project role permission and/or order", + "isasync": false, + "name": "updateProjectRolePermission", + "params": [ + { + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "ruleorder", + "related": "listProjectRolePermissions", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", + "description": "ID of the project role", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": true, "type": "uuid" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "ID of project where project role permission is to be updated", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, "type": "uuid" }, { - "description": "the netmask of the VLAN IP range", + "description": "Rule permission, can be: allow or deny", "length": 255, - "name": "netmask", + "name": "permission", "required": false, "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "Project Role permission rule id", "length": 255, - "name": "startip", + "name": "projectrolepermissionid", + "related": "listProjectRolePermissions", "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the ending IP address in the VLAN IP range", - "length": 255, - "name": "endip", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "description": "true if operation 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" + }, + { + "description": "Adds user to a project", + "isasync": true, + "name": "addUserToProject", + "params": [ + { + "description": "ID of the project role", "length": 255, - "name": "ip6gateway", + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", + "description": "Project role type to be assigned to the user - Admin/Regular", "length": 255, - "name": "vlan", + "name": "roletype", "required": false, "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "email ID of user to which invitation to the project is going to be sent", "length": 255, - "name": "ip6cidr", + "name": "email", "required": false, "type": "string" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "Name of the user to be added to the project", "length": 255, - "name": "forsystemvms", - "required": false, - "type": "boolean" + "name": "username", + "required": true, + "type": "string" }, { - "description": "the physical network id", + "description": "ID of the project to add the user to", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, "type": "uuid" } ], - "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "response": [ { - "description": "the cidr of the VLAN IP range", - "name": "cidr", - "type": "string" - }, - { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, - { - "description": "the ID of the VLAN IP range", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the Pod name for the VLAN IP range", - "name": "podname", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, {}, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the account of the VLAN IP range", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the project name of the vlan range", - "name": "project", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ], + "since": "4.14" + }, + { + "description": "Disables HA cluster-wide", + "isasync": true, + "name": "disableHAForCluster", + "params": [ { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" - }, + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the start ip of the VLAN IP range", - "name": "startip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.11" + }, + { + "description": "delete Tungsten-Fabric firewall policy", + "isasync": true, + "name": "deleteTungstenFabricFirewallPolicy", + "params": [ { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": true, "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "the ID of zone", + "length": 255, "name": "zoneid", - "type": "string" - }, - { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", - "type": "string" - }, + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ {}, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "any text associated with the 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 project id of the vlan range", - "name": "projectid", - "type": "string" - }, - { - "description": "the description of the VLAN IP range", - "name": "description", - "type": "string" - }, - { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Updates site to site vpn connection", - "isasync": true, - "name": "updateVpnConnection", + "description": "Recovers a virtual machine.", + "isasync": false, + "name": "recoverVirtualMachine", "params": [ { - "description": "id of vpn connection", + "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "related": "assignVirtualMachine,recoverVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": true, "type": "uuid" - }, - { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" } ], - "related": "createVpnConnection,listVpnConnections", + "related": "assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "response": [ - {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, - {}, { - "description": "State of vpn connection", - "name": "state", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the domain id of the owner", - "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": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + {}, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + {}, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -56796,288 +54606,869 @@ "type": "integer" }, { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "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" - } - ], - "since": "4.4" - }, - { - "description": "lists network that are using Palo Alto firewall device", - "isasync": false, - "name": "listPaloAltoFirewallNetworks", - "params": [ + }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the 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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "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": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag 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" + }, + { + "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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "palo alto balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, - "type": "uuid" - } - ], - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "response": [ + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the 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 network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the traffic type of the nic", + "name": "traffictype", + "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 IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the 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 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 extra dhcp options on the nic", + "name": "extradhcpoption", + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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 ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ], + "type": "set" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "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 network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -57086,13 +55477,28 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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" }, { @@ -57101,295 +55507,331 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { "description": "customer associated with the tag", "name": "customer", "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the project name of the address", - "name": "project", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, - {}, { - "description": "the name of the network", - "name": "name", - "type": "string" - }, + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + } + ] + }, + { + "description": "Resets network permissions.", + "isasync": false, + "name": "resetNetworkPermissions", + "params": [ { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "any text associated with the 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": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.17.0" + }, + { + "description": "Updates an existing Bgp Peer.", + "isasync": true, + "name": "updateBgpPeer", + "params": [ { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "Id of the Bgp Peer", + "length": 255, + "name": "id", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "required": true, + "type": "uuid" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "The AS number of the Bgp Peer.", + "length": 255, + "name": "asnumber", + "required": false, + "type": "long" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The password of the Bgp Peer.", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "BGP peer details in key/value pairs.", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details are removed for this resource; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "The IPv6 address of the Bgp Peer.", + "length": 255, + "name": "ip6address", + "required": false, "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, + "description": "The IPv4 address of the Bgp Peer.", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + } + ], + "related": "createBgpPeer,listBgpPeers,dedicateBgpPeer,releaseBgpPeer", + "response": [ { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "id of the bgp peer", + "name": "id", + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the project id of the bgp peer", + "name": "projectid", "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": "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": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" }, { - "description": "the name of the zone the network belongs to", + "description": "name of zone to which the bgp peer belongs to.", "name": "zonename", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" } - ] + ], + "since": "4.20.0" }, { - "description": "Synchronize Tungsten-Fabric data", - "isasync": false, - "name": "synchronizeTungstenFabricData", + "description": "update Tungsten-Fabric loadbalancer health monitor", + "isasync": true, + "name": "updateTungstenFabricLBHealthMonitor", "params": [ { - "description": "provider id", + "description": "loadbalancer health monitor url path", "length": 255, - "name": "id", - "related": "listTungstenFabricProviders", + "name": "urlpath", + "required": false, + "type": "string" + }, + { + "description": "loadbalancer health monitor type", + "length": 255, + "name": "type", + "required": true, + "type": "string" + }, + { + "description": "loadbalancer health monitor interval", + "length": 255, + "name": "interval", + "required": true, + "type": "integer" + }, + { + "description": "the ID of lb rule", + "length": 255, + "name": "lbruleid", + "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", "required": true, "type": "uuid" + }, + { + "description": "loadbalancer health monitor retry", + "length": 255, + "name": "retry", + "required": true, + "type": "integer" + }, + { + "description": "loadbalancer health monitor expected code", + "length": 255, + "name": "expectedcode", + "required": false, + "type": "string" + }, + { + "description": "loadbalancer health monitor timeout", + "length": 255, + "name": "timeout", + "required": true, + "type": "integer" + }, + { + "description": "loadbalancer health monitor http method", + "length": 255, + "name": "httpmethodtype", + "required": false, + "type": "string" } ], + "related": "", "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the health monitor url path", + "name": "urlpath", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { @@ -57397,47 +55839,97 @@ "name": "jobid", "type": "string" }, + { + "description": "the health monitor timeout", + "name": "timeout", + "type": "int" + }, + { + "description": "the health monitor interval", + "name": "interval", + "type": "int" + }, + { + "description": "the health monitor UUID", + "name": "uuid", + "type": "string" + }, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the health monitor expected code", + "name": "expectedcode", + "type": "string" + }, + { + "description": "the health monitor retry", + "name": "retry", + "type": "int" }, { "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 health monitor ID", + "name": "id", + "type": "long" + }, + { + "description": "the health monitor type", + "name": "type", + "type": "string" + }, + { + "description": "the health monitor http method", + "name": "httpmethod", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, {} ] }, { - "description": "Get the path associated with the provided volume UUID", - "isasync": false, - "name": "getPathForVolume", + "description": "Release the dedication for host", + "isasync": true, + "name": "releaseDedicatedHost", "params": [ { - "description": "CloudStack Volume UUID", + "description": "the ID of the host", "length": 255, - "name": "volumeid", + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "The path field for the volume", - "name": "path", + "description": "true if 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", @@ -57446,62 +55938,52 @@ ] }, { - "description": "Lists management servers.", - "isasync": false, - "name": "listManagementServers", + "description": "Accepts or declines project invitation", + "isasync": true, + "name": "updateProjectInvitation", "params": [ { - "description": "the id of the management server", + "description": "if true, accept the invitation, decline if false. True by default", "length": 255, - "name": "id", - "related": "listManagementServers", + "name": "accept", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "pagesize", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "list invitations for specified account; this parameter has to be specified with domainId", "length": 255, - "name": "page", + "name": "token", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the name of the management server", + "description": "id of the project to join", "length": 255, - "name": "name", - "required": false, - "type": "string" + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "account that is joining the project", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" } ], - "related": "", "response": [ { - "description": "the state of the management server", - "name": "state", - "type": "state" - }, - { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" - }, - { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -57509,157 +55991,199 @@ "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the IP Address for this Management Server", - "name": "serviceip", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "3.0.0" + }, + { + "description": "This is supposed to revert a volume snapshot. This command is only supported with KVM so far", + "isasync": true, + "name": "revertSnapshot", + "params": [ { - "description": "the name of the management server", - "name": "name", - "type": "string" - }, - {}, + "description": "The ID of the snapshot", + "length": 255, + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", + "required": true, + "type": "uuid" + } + ], + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "response": [ { - "description": "the version of the management server", - "name": "version", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, {}, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "the last time this Management Server was started", - "name": "lastserverstart", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the 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 ID of the management server", - "name": "id", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" - } - ] - }, - { - "description": "list Tungsten-Fabric policy", - "isasync": false, - "name": "listTungstenFabricPolicyRule", - "params": [ + }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "the uuid of Tungsten-Fabric rule", - "length": 255, - "name": "ruleuuid", - "required": false, + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": true, + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" - } - ], - "related": "addTungstenFabricPolicyRule", - "response": [ + }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "Tungsten-Fabric policy action", - "name": "action", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", "type": "long" }, - {}, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" }, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, - {}, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", - "type": "int" + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -57667,33 +56191,39 @@ "type": "string" }, { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + {}, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", - "type": "int" + "description": "name of the snapshot", + "name": "name", + "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "direction", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -57702,130 +56232,152 @@ "type": "integer" }, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", - "type": "int" + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" + }, + { + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" } ] }, { - "description": "delete Tungsten-Fabric policy", + "description": "Updates a condition for VM auto scaling", "isasync": true, - "name": "deleteTungstenFabricPolicy", + "name": "updateCondition", "params": [ { - "description": "the Uuid of Tungsten-Fabric tag type", + "description": "the ID of the condition.", "length": 255, - "name": "policyuuid", + "name": "id", + "related": "listConditions", + "required": true, + "type": "uuid" + }, + { + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "length": 255, + "name": "relationaloperator", "required": true, "type": "string" }, { - "description": "the ID of zone", + "description": "Value for which the Counter will be evaluated with the Operator selected.", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "threshold", "required": true, - "type": "uuid" + "type": "long" } ], "response": [ {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] + {} + ], + "since": "4.18.0" }, { - "description": "Updates a vm group", + "description": "Lists Regions", "isasync": false, - "name": "updateInstanceGroup", + "name": "listRegions", "params": [ { - "description": "new instance group name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Instance group ID", + "description": "", "length": 255, - "name": "id", - "related": "createInstanceGroup,updateInstanceGroup", - "required": true, - "type": "uuid" - } - ], - "related": "createInstanceGroup", - "response": [ - {}, - {}, - { - "description": "the domain ID of the instance group", - "name": "domainid", - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "List Region by region ID.", + "length": 255, + "name": "id", + "required": false, + "type": "integer" }, { - "description": "the account owning the instance group", - "name": "account", + "description": "List Region by region name.", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" - }, - { - "description": "the project name of the instance group", - "name": "project", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "addRegion,updateRegion", + "response": [ { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, { - "description": "the project ID of the instance group", - "name": "projectid", - "type": "string" + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the instance group", + "description": "the ID of the region", + "name": "id", + "type": "integer" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" + }, + { + "description": "the name of the region", "name": "name", "type": "string" }, @@ -57834,196 +56386,169 @@ "name": "jobid", "type": "string" }, - { - "description": "the ID of the instance group", - "name": "id", - "type": "string" - } + {} ] }, { - "description": "Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering", + "description": "Attempts Migration of a system virtual machine to the host specified.", "isasync": true, - "name": "changeOfferingForVolume", + "name": "migrateSystemVm", "params": [ { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "destination Host ID to migrate VM to", "length": 255, - "name": "maxiops", + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": false, - "type": "long" - }, - { - "description": "new disk offering id", - "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", - "required": true, "type": "uuid" }, { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "type": "long" - }, - { - "description": "New volume size in GB for the custom disk offering", - "length": 255, - "name": "size", - "required": false, - "type": "long" - }, - { - "description": "the ID of the volume", + "description": "the ID of the virtual machine", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,changeOfferingForVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "virtualmachineid", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": true, "type": "uuid" }, { - "description": "Verify OK to Shrink", + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, - "name": "shrinkok", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "boolean" + "since": "4.16.0", + "type": "uuid" }, { - "description": "Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering", + "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": "automigrate", + "name": "autoselect", "required": false, + "since": "4.16.0", "type": "boolean" } ], - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "name of the disk volume", - "name": "name", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "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 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 last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the second DNS for the system VM", + "name": "dns2", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, + {}, { - "description": "pod id of the volume", - "name": "podid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { @@ -58032,362 +56557,347 @@ "type": "integer" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the template name for the system VM", + "name": "templatename", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "ID of the disk volume", + "description": "the ID of the system VM", "name": "id", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, + {}, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "List the counters for VM auto scaling", + "isasync": false, + "name": "listCounters", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "Name of the counter.", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the Counter.", + "length": 255, + "name": "id", + "related": "createCounter,listCounters", + "required": false, + "type": "uuid" + }, + { + "description": "Network provider of the counter.", + "length": 255, + "name": "provider", + "required": false, + "since": "4.18.0", "type": "string" }, - {}, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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 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" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "Source of the counter.", + "length": 255, + "name": "source", + "required": false, "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "createCounter", + "response": [ { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "Name of the counter.", + "name": "name", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "Source of the counter.", + "name": "source", "type": "string" }, + {}, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "Provider of the counter.", + "name": "provider", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the id of the Counter", + "name": "id", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, + } + ] + }, + { + "description": "Configures an Internal Load Balancer element.", + "isasync": true, + "name": "configureInternalLoadBalancerElement", + "params": [ { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "the ID of the internal lb provider", + "length": 255, + "name": "id", + "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", + "required": true, + "type": "uuid" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, + "description": "Enables/Disables the Internal Load Balancer element", + "length": 255, + "name": "enabled", + "required": true, + "type": "boolean" + } + ], + "related": "listInternalLoadBalancerElements", + "response": [ + {}, { - "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": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the physical network service provider id of the element", + "name": "nspid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the id of the internal load balancer element", + "name": "id", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" } ], - "since": "4.17" + "since": "4.2.0" }, { - "description": "List the uploaded certificates for direct download templates", - "isasync": false, - "name": "listTemplateDirectDownloadCertificates", + "description": "remove Tungsten-Fabric tag", + "isasync": true, + "name": "removeTungstenFabricTag", "params": [ { - "description": "", + "description": "the uuid of networks", "length": 255, - "name": "pagesize", + "name": "networkuuid", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the zone where certificates are uploaded", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "policyuuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "keyword", - "required": false, + "name": "taguuid", + "required": true, "type": "string" }, { - "description": "if set to true: include the hosts where the certificate is uploaded to", + "description": "the ID of zone", "length": 255, - "name": "listhosts", + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the uuid of nics", + "length": 255, + "name": "nicuuid", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "page", + "name": "applicationpolicysetuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list direct download certificate by ID", + "description": "the uuid of vms", "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate,listTemplateDirectDownloadCertificates", + "name": "vmuuid", "required": false, - "type": "uuid" + "type": "list" } ], - "related": "uploadTemplateDirectDownloadCertificate", + "related": "createTungstenFabricTag,listTungstenFabricTag,applyTungstenFabricTag", "response": [ { - "description": "the direct download certificate serial num", - "name": "serialnum", - "type": "string" - }, - { - "description": "the zone name where the certificate is uploaded", + "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { - "description": "the direct download certificate id", - "name": "id", - "type": "string" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" + }, + { + "description": "list Tungsten-Fabric vm", + "name": "vm", "type": "list" }, - {}, { - "description": "the direct download certificate alias", - "name": "alias", - "type": "string" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, + {}, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { @@ -58396,63 +56906,53 @@ "type": "integer" }, { - "description": "the direct download certificate issuer", - "name": "validity", - "type": "string" - }, - { - "description": "the direct download certificate version", - "name": "version", - "type": "string" - }, - {}, - { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the direct download certificate issuer", - "name": "issuer", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } - ], - "since": "4.17.0" + ] }, { - "description": "List ucs manager", + "description": "Lists all available virtual router elements.", "isasync": false, - "name": "listUcsManagers", + "name": "listVirtualRouterElements", "params": [ { - "description": "List by keyword", + "description": "list virtual router elements by network service provider id", "length": 255, - "name": "keyword", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the zone id", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the ucs manager", + "description": "list virtual router elements by id", "length": 255, "name": "id", - "related": "listUcsManagers,addUcsManager", + "related": "configureVirtualRouterElement,listVirtualRouterElements", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "list network offerings by enabled state", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" }, { "description": "", @@ -58462,129 +56962,92 @@ "type": "integer" } ], - "related": "addUcsManager", + "related": "configureVirtualRouterElement", "response": [ - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of ucs manager", - "name": "name", - "type": "string" - }, - { - "description": "the url of ucs manager", - "name": "url", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the ucs manager", + "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" - } - ] - }, - { - "description": "Upgrades domain router to a new service offering", - "isasync": false, - "name": "changeServiceForRouter", - "params": [ - { - "description": "the service offering ID to apply to the domain router", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" }, { - "description": "The ID of the router", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" - } - ], - "related": "destroyRouter,listRouters,listInternalLoadBalancerVMs", - "response": [ - { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the domain ID associated with the provider", + "name": "domainid", "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 version of template", - "name": "version", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the provider", + "name": "account", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "Enabled/Disabled the service provider", + "name": "enabled", "type": "boolean" }, + {} + ] + }, + { + "description": "Deletes an existing IPv4 subnet for guest network.", + "isasync": true, + "name": "deleteIpv4SubnetForGuestNetwork", + "params": [ { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "Id of the guest network IPv4 subnet", + "length": 255, + "name": "id", + "related": "createIpv4SubnetForGuestNetwork", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -58593,1251 +57056,965 @@ "type": "integer" }, { - "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 state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "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 network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.20.0" + }, + { + "description": "Creates a routing firewall rule in the given network in ROUTED mode", + "isasync": true, + "name": "createRoutingFirewallRule", + "params": [ { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" }, { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" + "description": "the starting port of firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, "type": "boolean" }, - {}, - { - "description": "the version of the code / software in the router", - "name": "softwareversion", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "destcidrlist", + "required": false, + "type": "list" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" + "description": "The network of the VM the firewall rule will be created for", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" + "description": "the ending port of firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" - }, + } + ], + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "response": [ { - "description": "the domain associated with the router", - "name": "domain", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the 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 ID of the nic", - "name": "id", - "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 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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", - "response": [ - { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" - }, - { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "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" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the id of the router", + "description": "the ID of the port forwarding rule", "name": "id", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", + "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 corresponding guest network", - "name": "guestnetworkname", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, {}, { - "description": "the project name of the address", - "name": "project", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, + {}, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Remove an Ldap Configuration", + "description": "link a cloudstack account to a group or OU in ldap", "isasync": false, - "name": "deleteLdapConfiguration", + "name": "linkAccountToLdap", "params": [ { - "description": "port", + "description": "domain admin username in LDAP ", "length": 255, - "name": "port", + "name": "admin", + "required": false, + "type": "string" + }, + { + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "length": 255, + "name": "accounttype", "required": false, "type": "integer" }, { - "description": "Hostname", + "description": "type of the ldap name. GROUP or OU, defaults to GROUP", "length": 255, - "name": "hostname", + "name": "type", + "required": false, + "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": "linked domain", + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "ldapdomain", + "required": true, + "type": "string" + }, + { + "description": "The id of the domain that is to contain the linked account.", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" + }, + { + "description": "Creates the account under the specified role.", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", "required": false, + "since": "4.19.1", "type": "uuid" } ], - "related": "addLdapConfiguration", + "related": "", "response": [ + { + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", + "type": "string" + }, + { + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "name", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", "type": "string" }, { - "description": "port the ldap server is running on", - "name": "port", + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", + "type": "string" + }, + { + "description": "Type of the account to auto import", + "name": "accounttype", "type": "int" }, - {}, - {}, { - "description": "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" }, + {}, { - "description": "linked domain", - "name": "domainid", + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" } ], - "since": "4.2.0" + "since": "4.11.0" }, { - "description": "Updates the volume.", + "description": "Disables out-of-band management for a host", "isasync": true, - "name": "updateVolume", + "name": "disableOutOfBandManagementForHost", "params": [ { - "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 ID of the disk volume", + "description": "the ID of the host", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,updateVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, + "name": "hostid", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, "type": "uuid" - }, + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ { - "description": "new name of the volume", - "length": 255, - "name": "name", - "required": false, - "since": "4.16", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, { - "description": "The chain info of the volume", - "length": 255, - "name": "chaininfo", - "required": false, - "since": "4.4", + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "Destination storage pool UUID for the volume", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.3", - "type": "uuid" - }, - { - "description": "The path of the volume", - "length": 255, - "name": "path", - "required": false, + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "The state of the volume", - "length": 255, - "name": "state", - "required": false, - "since": "4.3", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - } - ], - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - {}, - { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "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", + "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": "pod id of the volume", - "name": "podid", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + } + ], + "since": "4.9.0" + }, + { + "description": "Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'.", + "isasync": true, + "name": "cancelHostAsDegraded", + "params": [ { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "host ID", + "length": 255, + "name": "id", + "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "response": [ + { + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "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": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "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 Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "cluster name where the volume is allocated", + "description": "the cluster name of the host", "name": "clustername", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "type": "long" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "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" - } - ], - "type": "set" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the host supports encryption", + "name": "encryptionsupported", "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, - {}, { - "description": "the status of the volume", - "name": "status", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "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 host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the admin that annotated this host", + "name": "username", "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 amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, + {}, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "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", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, + {}, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - } - ] - }, - { - "description": "Lists traffic types of a given physical network.", - "isasync": false, - "name": "listTrafficTypes", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" - } - ], - "related": "listNetworkServiceProviders", - "response": [ - {}, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", - "name": "name", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "state of the network provider", - "name": "state", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", - "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 physical network this belongs to", - "name": "physicalnetworkid", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" } ], - "since": "3.0.0" + "since": "4.16.0.0" }, { - "description": "Creates a Project role", + "description": "Releases an AS Number back to the pool", "isasync": false, - "name": "createProjectRole", + "name": "releaseASNumber", "params": [ { - "description": "creates a project role with this unique name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "ID of project where role is being created", + "description": "the zone ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "zoneid", + "related": "createZone,listZones", "required": true, "type": "uuid" }, { - "description": "The description of the Project role", + "description": "the AS Number to be released", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "asnumber", + "required": true, + "type": "long" } ], - "related": "updateProjectRole", "response": [ {}, {}, { - "description": "the ID of the role", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the id of the project", - "name": "projectid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the name of the role", - "name": "name", + "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 description of the role", - "name": "description", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" } ], - "since": "4.15.0" + "since": "4.20.0" }, { - "description": "Creates an Ipv6 firewall rule in the given network (the network has to belong to VPC)", - "isasync": true, - "name": "createIpv6FirewallRule", + "description": "Creates a security group", + "isasync": false, + "name": "createSecurityGroup", "params": [ { - "description": "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", - "length": 255, - "name": "traffictype", - "required": false, - "type": "string" - }, - { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", - "required": true, - "type": "string" - }, - { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "destcidrlist", - "required": false, - "type": "list" - }, - { - "description": "the starting port of Ipv6 firewall rule", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "startport", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "cidrlist", + "name": "account", "required": false, - "type": "list" + "type": "string" }, { - "description": "the ending port of Ipv6 firewall rule", + "description": "name of the security group", "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "name": "name", + "required": true, + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the description of the security group", "length": 255, - "name": "fordisplay", + "name": "description", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "error code for this ICMP message", + "description": "Create security group for project", "length": 255, - "name": "icmpcode", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "type": "integer" - }, - { - "description": "The network of the VM the Ipv6 firewall rule will be created for", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, "type": "uuid" - }, - { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" } ], - "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", + "related": "updateSecurityGroup", "response": [ { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" - }, - {}, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "type": "integer" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" - }, - {}, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -59845,8 +58022,13 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -59860,230 +58042,361 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "list" - } - ] - }, - { - "description": "Updates account information for the authenticated user", - "isasync": false, - "name": "updateAccount", - "params": [ - { - "description": "The UUID of the dynamic role to set for the account", - "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, - "type": "uuid" - }, - { - "description": "Details for the account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" - }, - { - "description": "Network domain for the account's networks; empty string will update domainName with NULL value", - "length": 255, - "name": "networkdomain", - "required": false, - "type": "string" - }, - { - "description": "Account UUID", - "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,updateAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - }, - { - "description": "The UUID of the domain where the account exists", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "New name for the account", - "length": 255, - "name": "newname", - "required": false, - "type": "string" - }, - { - "description": "Current account name", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", - "response": [ - { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" - }, - { - "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 number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "type": "set" }, { - "description": "the id of the account", - "name": "id", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "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": "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 id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the name of the security group", + "name": "name", "type": "string" }, + {}, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, + {}, { - "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 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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + } + ] + }, + { + "description": "List network visibility and all accounts that have permissions to view this network.", + "isasync": false, + "name": "listNetworkPermissions", + "params": [ { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" - }, + "description": "Lists network permission by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the name of the domain to which the network belongs", + "name": "domain", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the state of the account", - "name": "state", + "description": "the account the network is available for", + "name": "account", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the ID of the domain to which the network belongs", + "name": "domainid", + "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the network ID", + "name": "networkid", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the ID of project the network is available for", + "name": "projectid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -60091,1367 +58404,996 @@ "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the ID of account the network is available for", + "name": "accountid", + "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the project the network is available for", + "name": "project", "type": "string" }, + {} + ], + "since": "4.17.0" + }, + { + "description": "Lists site 2 site vpn gateways", + "isasync": false, + "name": "listVpnGateways", + "params": [ { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "id of the vpn gateway", + "length": 255, + "name": "id", + "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "required": false, + "type": "uuid" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "id of vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, - {}, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, + "type": "uuid" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "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 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 domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - } - ], - "type": "list" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + } + ], + "related": "createVpnGateway,updateVpnGateway", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the vpc id of this gateway", + "name": "vpcid", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the owner", + "name": "account", + "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the vpc name of this gateway", + "name": "vpcname", + "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" + "description": "the project name", + "name": "project", + "type": "string" }, { - "description": "the name of the account", - "name": "name", + "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 ID of the role", - "name": "roleid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, + {}, + {}, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" + } + ] + }, + { + "description": "Moves a user to another account in the same domain.", + "isasync": false, + "name": "moveUser", + "params": [ + { + "description": "id of the user to be moved.", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name.", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id.", + "length": 255, + "name": "account", + "required": false, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {} + ], + "since": "4.11" + }, + { + "description": "Releases host reservation.", + "isasync": true, + "name": "releaseHostReservation", + "params": [ { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the host ID", + "length": 255, + "name": "id", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, { - "description": "Adds secondary storage.", - "isasync": false, - "name": "addSecondaryStorage", + "description": "Create site to site vpn connection", + "isasync": true, + "name": "createVpnConnection", "params": [ { - "description": "the Zone ID for the secondary storage", + "description": "id of the vpn gateway", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, + "name": "s2svpngatewayid", + "related": "createVpnGateway,updateVpnGateway", + "required": true, "type": "uuid" }, { - "description": "the URL for the secondary storage", + "description": "id of the customer gateway", "length": 255, - "name": "url", + "name": "s2scustomergatewayid", + "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "required": true, - "type": "string" + "type": "uuid" + }, + { + "description": "connection is passive or not", + "length": 255, + "name": "passive", + "required": false, + "type": "boolean" + }, + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], - "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "related": "updateVpnConnection", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the public IP address", + "name": "publicip", + "type": "string" + }, + { + "description": "the project name", + "name": "project", + "type": "string" }, {}, { - "description": "the name of the image store", - "name": "name", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "the connection ID", + "name": "id", "type": "string" }, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" + }, + { + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", "type": "long" }, + { + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "State of vpn connection", + "name": "state", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" + }, + { + "description": "the project id", + "name": "projectid", + "type": "string" + }, + { + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.", + "description": "lists network that are using a brocade vcs switch", "isasync": false, - "name": "updateVirtualMachine", + "name": "listBrocadeVcsDeviceNetworks", "params": [ { - "description": "user generated name", + "description": "", "length": 255, - "name": "displayname", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", - "required": false, - "since": "4.12", - "type": "string" + "description": "brocade vcs switch ID", + "length": 255, + "name": "vcsdeviceid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "List by keyword", "length": 255, - "name": "customid", + "name": "keyword", "required": false, - "since": "4.4", "type": "string" + } + ], + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "response": [ + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", - "length": 255, - "name": "dhcpoptionsnetworklist", - "required": false, - "type": "map" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "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": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", - "length": 255, - "name": "displayvm", - "required": false, + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "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, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "group of the virtual machine", - "length": 255, - "name": "group", - "required": false, + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the ID of the userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.18", - "type": "uuid" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18", - "type": "map" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "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 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": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.16.0", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the ID of the OS type that best represents this VM.", - "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": false, - "type": "uuid" + "description": "the type of the network", + "name": "type", + "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": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" }, { - "description": "instance name of the user vm", - "length": 255, - "name": "instancename", - "required": false, - "since": "4.4", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "true if high-availability is enabled for the virtual machine, false otherwise", - "length": 255, - "name": "haenable", - "required": false, - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "list of security group ids to be applied on the virtual machine.", - "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", - "required": false, - "type": "list" - } - ], - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + {}, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, - {}, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", "response": [ { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "tag key name", + "name": "key", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the network domain", + "name": "networkdomain", "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", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "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" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the 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" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the 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 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": "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "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" - } - ], - "type": "set" + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "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": "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": "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": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "the account associated with the virtual machine", + "description": "the owner of the network", "name": "account", "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "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 vm", - "name": "project", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, + {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, - {}, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "AS NUMBER", + "name": "asnumber", "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 group name of the virtual machine", - "name": "group", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -61459,815 +59401,821 @@ "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "zone id of the network", + "name": "zoneid", "type": "string" - }, + } + ] + }, + { + "description": "Lists Webhook deliveries", + "isasync": false, + "name": "listWebhookDeliveries", + "params": [ { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "The ID of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": false, + "type": "uuid" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The event type of the Webhook delivery", + "length": 255, + "name": "eventtype", + "required": false, "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The start date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having start date equal to or after the specified date will be listed.", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "The ID of the Webhook delivery", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "The end date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having end date equal to or before the specified date will be listed.", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, + "description": "The ID of the Webhook", + "length": 255, + "name": "webhookid", + "related": "createWebhook,listWebhookDeliveries", + "required": false, + "type": "uuid" + } + ], + "related": "createWebhook", + "response": [ { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "The name of the domain in which the Webhook 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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "The secret key for the Webhook", + "name": "secretkey", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, - {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, + {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "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 project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, + {}, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" + }, + { + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" } - ] + ], + "since": "4.20.0" }, { - "description": "Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobbs have been completed. Triggers an immediate shutdown if forced", - "isasync": false, - "name": "triggerShutdown", + "description": "Dedicates a host.", + "isasync": true, + "name": "dedicateHost", "params": [ { - "description": "the uuid of the management server", + "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, - "name": "managementserverid", - "related": "", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the ID of the host to update", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" } ], - "related": "prepareForShutdown", + "related": "listDedicatedHosts", "response": [ + {}, { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", + "type": "string" }, - {}, - {}, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "the Account ID of the host", + "name": "accountid", + "type": "string" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", - "type": "boolean" + "description": "the name of the host", + "name": "hostname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the host", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the host", + "name": "hostid", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ], - "since": "4.19.0" + ] }, { - "description": "Disables an account", + "description": "Adds the GloboDNS external host", "isasync": true, - "name": "disableAccount", + "name": "addGloboDnsHost", "params": [ { - "description": "Account id", + "description": "Password for GloboDNS", "length": 255, - "name": "id", - "related": "createAccount,disableAccount,enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" + "name": "password", + "required": true, + "type": "string" }, { - "description": "Disables specified account.", + "description": "the Physical Network ID", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "Disables specified account in this domain.", + "description": "GloboDNS url", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "name": "url", + "required": true, + "type": "string" }, { - "description": "If true, only lock the account; else disable the account", + "description": "Username for GloboDNS", "length": 255, - "name": "lock", + "name": "username", "required": true, - "type": "boolean" + "type": "string" } ], - "related": "createAccount,enableAccount,listAccounts,listAccounts", "response": [ { - "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 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 vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.5.0" + }, + { + "description": "Logs out the user", + "isasync": false, + "name": "logout", + "params": [], + "related": "", + "response": [ { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "Response description", + "name": "description", "type": "string" }, + {}, + {}, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Imports a role based on provided map of rule permissions", + "isasync": false, + "name": "importRole", + "params": [ { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "Creates a role with this unique name", + "length": 255, + "name": "name", + "required": true, "type": "string" }, - {}, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", + "length": 255, + "name": "rules", + "required": true, + "type": "map" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "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 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", + "description": "The description of the role", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "length": 255, + "name": "type", + "required": false, "type": "string" - }, + } + ], + "related": "createRole,listRoles,updateRole", + "response": [ { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the name of the role", + "name": "name", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the type of the role", + "name": "type", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the description of the role", + "name": "description", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the state of the role", + "name": "state", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the role", + "name": "id", + "type": "string" }, + {}, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Restart a Shared FileSystem", + "isasync": true, + "name": "restartSharedFileSystem", + "params": [ { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "is cleanup required", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "Lists network serviceproviders for a given physical network.", + "isasync": false, + "name": "listNetworkServiceProviders", + "params": [ { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "list providers by name", + "length": 255, + "name": "name", + "required": false, "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 allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "list providers by state", + "length": 255, + "name": "state", + "required": false, "type": "string" - }, + } + ], + "related": "addNetworkServiceProvider,listTrafficTypes", + "response": [ { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - } - ], - "type": "list" + "description": "the provider name", + "name": "name", + "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "state of the network provider", + "name": "state", + "type": "string" }, {}, { - "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": "name of the Domain the account belongs to", - "name": "domain", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, + {}, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "since": "3.0.0" + }, + { + "description": "delete Tungsten-Fabric tag type", + "isasync": true, + "name": "deleteTungstenFabricTagType", + "params": [ { - "description": "the ID of the role", - "name": "roleid", + "description": "the ID of Tungsten-Fabric tag type", + "length": 255, + "name": "tagtypeuuid", + "required": true, "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "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 list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Deletes an Object Storage Pool", + "isasync": false, + "name": "deleteObjectStoragePool", + "params": [ { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "The Object Storage ID.", + "length": 255, + "name": "id", + "related": "addObjectStoragePool,updateObjectStoragePool", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the name of the account", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.19.0" + }, + { + "description": "Delete Netscaler Control Center", + "isasync": false, + "name": "deleteNetscalerControlCenter", + "params": [ { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "Netscaler Control Center ID", + "length": 255, + "name": "id", + "related": "", + "required": true, "type": "string" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Lists domains and provides detailed information for listed domains", + "description": "Deletes a detached disk volume.", "isasync": false, - "name": "listDomains", + "name": "deleteVolume", "params": [ { - "description": "", + "description": "The ID of the disk volume", "length": 255, - "name": "page", - "required": false, + "name": "id", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", - "length": 255, - "name": "listall", - "required": false, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", - "length": 255, - "name": "details", - "required": false, - "type": "list" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "List domain by domain ID.", - "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains,listDomains", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {} + ] + }, + { + "description": "Updates an existing secondary storage selector.", + "isasync": false, + "name": "updateSecondaryStorageSelector", + "params": [ { - "description": "flag to display the resource icon for domains", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", + "length": 65535, + "name": "heuristicrule", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "The unique identifier of the secondary storage selector.", "length": 255, - "name": "keyword", - "required": false, + "name": "id", + "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", + "required": true, + "type": "uuid" + } + ], + "related": "listSecondaryStorageSelectors", + "response": [ + { + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" }, { - "description": "List domains by domain level.", - "length": 255, - "name": "level", - "required": false, + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "List domain by domain name.", - "length": 255, + "description": "Name of the heuristic.", "name": "name", - "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "listDomainChildren,listDomains", - "response": [ + "description": "Description of the heuristic.", + "name": "description", + "type": "string" + }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", "type": "string" }, { @@ -62276,90 +60224,121 @@ "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "ID of the heuristic.", + "name": "id", "type": "string" }, + {}, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" + "description": "When the heuristic was created.", + "name": "created", + "type": "date" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "Enables a user account", + "isasync": false, + "name": "enableUser", + "params": [ { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "Enables user by user ID.", + "length": 255, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + } + ], + "related": "createUser,disableUser,getUser,listUsers,lockUser", + "response": [ + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, - {}, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the date when this domain 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": "Base64 string representation of the resource icon", @@ -62367,518 +60346,526 @@ "type": "resourceiconresponse" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "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", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the account name of the user", + "name": "account", + "type": "string" + } + ] + }, + { + "description": "Suspends a project", + "isasync": true, + "name": "suspendProject", + "params": [ + { + "description": "id of the project to be suspended", + "length": 255, + "name": "id", + "related": "activateProject,createProject,suspendProject", + "required": true, + "type": "uuid" + } + ], + "related": "activateProject,createProject", + "response": [ + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, + {}, { - "description": "the state of the domain", + "description": "the state of the project", "name": "state", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the path of the domain", - "name": "path", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the name of the project", + "name": "name", "type": "string" }, + {}, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total number of snapshots stored by this project", + "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 project can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "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 domain", - "name": "snapshotlimit", + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" + }, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "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": "Updates a network", - "isasync": true, - "name": "updateNetwork", - "params": [ + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" + }, { - "description": "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", - "length": 255, - "name": "dns1", - "required": false, - "since": "4.18.0", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "privatemtu", - "required": false, - "since": "4.18.0", - "type": "integer" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the new display text for the network", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", - "length": 255, - "name": "guestvmcidr", - "required": false, - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", - "length": 255, - "name": "dns2", - "required": false, - "since": "4.18.0", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", - "length": 255, - "name": "sourcenatipaddress", - "required": false, - "since": "4.19", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", - "type": "integer" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "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": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "network domain", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the network", - "length": 255, - "name": "id", - "related": "createNetwork,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "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 key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" }, { - "description": "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", - "length": 255, - "name": "ip6dns1", - "required": false, - "since": "4.18.0", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "Force update even if CIDR type is different", - "length": 255, - "name": "changecidr", - "required": false, - "type": "boolean" + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { - "description": "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider", - "length": 255, - "name": "updateinsequence", - "required": false, - "type": "boolean" + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" }, { - "description": "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", - "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the new name for the network", - "length": 255, - "name": "name", - "required": false, + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Setting this to true will cause a forced network update,", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - } - ], - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "response": [ - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" - }, + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Get API limit count for the caller", + "isasync": false, + "name": "getApiLimit", + "params": [], + "related": "", + "response": [ { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "currently allowed number of apis", + "name": "apiAllowed", + "type": "int" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the account uuid of the api remaining count", + "name": "accountid", "type": "string" }, + {}, { - "description": "the owner of the network", + "description": "the account name of the api remaining count", "name": "account", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "seconds left to reset counters", + "name": "expireAfter", + "type": "long" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" - }, + "description": "number of api already issued", + "name": "apiIssued", + "type": "int" + } + ] + }, + { + "description": "Deletes a storage network IP Range.", + "isasync": true, + "name": "deleteStorageNetworkIpRange", + "params": [ { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, + "description": "the uuid of the storage network ip range", + "length": 255, + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, + {}, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Adds a VMware datacenter to specified zone", + "isasync": false, + "name": "addVmwareDc", + "params": [ { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "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": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "The password for specified username.", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "The Username required to connect to resource.", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "The Zone ID.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "Name of VMware datacenter to be added to specified zone.", + "length": 255, + "name": "name", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "The VMware Datacenter ID", + "name": "id", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "The VMware Datacenter name", + "name": "name", "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" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, { @@ -62887,184 +60874,192 @@ "type": "integer" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the Zone ID associated with this VMware Datacenter", + "name": "zoneid", + "type": "long" + } + ] + }, + { + "description": "Updates Ipv6 firewall rule with specified ID", + "isasync": true, + "name": "updateIpv6FirewallRule", + "params": [ + { + "description": "the starting port of Ipv6 firewall rule", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ending port of Ipv6 firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "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 second IPv4 DNS for the network", - "name": "dns2", + "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": false, "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ID of the ipv6 firewall rule", + "length": 255, + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "required": true, + "type": "uuid" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "the id of the network", - "name": "id", - "type": "string" - }, + "description": "error code for this ICMP message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" + } + ], + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "response": [ { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "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 VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "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" - }, - { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, - {}, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the state of the rule", + "name": "state", + "type": "string" }, + {}, + {}, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -63078,23 +61073,23 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -63103,1385 +61098,954 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "the name of the network", - "name": "name", - "type": "string" - }, - { - "description": "The routing mode of network offering", - "name": "ip6routing", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Updates ISO permissions", + "isasync": false, + "name": "updateIsoPermissions", + "params": [ { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "activateProject,createProject", + "required": false, + "type": "list" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true for public template/iso, false for private templates/isos", + "length": 255, + "name": "ispublic", + "required": false, "type": "boolean" }, { - "description": "the domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accounts", + "required": false, + "type": "list" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "true for featured template/iso, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, "type": "boolean" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "the template ID", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "permission operator (add, remove, reset)", + "length": 255, + "name": "op", + "required": false, "type": "string" - }, + } + ], + "response": [ { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, { - "description": "List Usage Types", - "isasync": false, - "name": "listUsageTypes", - "params": [], - "related": "", + "description": "Deletes VPC offering", + "isasync": true, + "name": "deleteVPCOffering", + "params": [ + { + "description": "the ID of the VPC offering", + "length": 255, + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", + "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": "usage type", - "name": "usagetypeid", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "description of usage type", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", - "isasync": false, - "name": "resetUserDataForVirtualMachine", + "description": "Deletes a network ACL", + "isasync": true, + "name": "deleteNetworkACL", "params": [ { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the ID of the network ACL", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "id", + "related": "createNetworkACL,updateNetworkACLItem,moveNetworkAclItem", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "an optional project for the virtual machine", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {} + ] + }, + { + "description": "List Autonomous Systems Number Ranges", + "isasync": false, + "name": "listASNRanges", + "params": [ { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "description": "List by keyword", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "", "length": 255, - "name": "userdatadetails", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the ID of the userdata", + "description": "", "length": 255, - "name": "userdataid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The ID of the virtual machine", + "description": "the zone ID", "length": 255, - "name": "id", - "related": "migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, + "name": "zoneid", + "related": "createZone,listZones", + "required": false, "type": "uuid" } ], - "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,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "", "response": [ { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "End AS Number", + "name": "endasn", + "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "Zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "Created date", + "name": "created", + "type": "date" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "ID of the AS Number Range", + "name": "id", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "Start AS Number", + "name": "startasn", "type": "long" }, + {}, + {} + ], + "since": "4.20.0" + }, + { + "description": "create Tungsten-Fabric tag", + "isasync": true, + "name": "createTungstenFabricTag", + "params": [ { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Tungsten-Fabric tag type", + "length": 255, + "name": "tagtype", + "required": true, "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Tungsten-Fabric tag value", + "length": 255, + "name": "tagvalue", + "required": true, "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "listTungstenFabricTag,applyTungstenFabricTag", + "response": [ { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" }, + {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", + "description": "list Tungsten-Fabric nic", + "name": "nic", "type": "list" - }, + } + ] + }, + { + "description": "Adds an OpenDyalight controler", + "isasync": true, + "name": "addOpenDaylightController", + "params": [ { - "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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": "Type of adapter if available", - "name": "adaptertype", - "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 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 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": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - } - ], - "type": "set" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Api URL of the OpenDaylight Controller.", + "length": 255, + "name": "url", + "required": true, + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Credential to access the OpenDaylight API", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Username to access the OpenDaylight API", + "length": 255, + "name": "username", + "required": true, + "type": "string" + } + ], + "related": "deleteOpenDaylightController", + "response": [ + { + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "device id of the controller", + "name": "id", "type": "string" }, + {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "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", + "description": "the username to authenticate to the controller", + "name": "username", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, + {}, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the url of the controller api", + "name": "url", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Creates a Zone.", + "isasync": false, + "name": "createZone", + "params": [ + { + "description": "true if local storage offering enabled, false otherwise", + "length": 255, + "name": "localstorageenabled", + "required": false, + "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the first internal DNS for the Zone", + "length": 255, + "name": "internaldns1", + "required": true, "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the second DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns2", + "required": false, "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "true if network is security group enabled, false otherwise", + "length": 255, + "name": "securitygroupenabled", + "required": false, + "type": "boolean" + }, + { + "description": "network type of the zone, can be Basic or Advanced", + "length": 255, + "name": "networktype", + "required": true, "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "Allocation state of this Zone for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the zone is an edge zone, false otherwise", + "length": 255, + "name": "isedge", + "required": false, + "since": "4.18.0", "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the second internal DNS for the Zone", + "length": 255, + "name": "internaldns2", + "required": false, + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the name of the Zone", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the first DNS for the Zone", + "length": 255, + "name": "dns1", + "required": true, "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the second DNS for the Zone", + "length": 255, + "name": "dns2", + "required": false, "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the containing domain, null for public zones", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "the guest CIDR address for the Zone", + "length": 255, + "name": "guestcidraddress", + "required": false, "type": "string" }, - {}, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Network domain name for the networks in the zone", + "length": 255, + "name": "domain", + "required": false, "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the first DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns1", + "required": false, + "type": "string" + } + ], + "related": "listZones", + "response": [ + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Zone name", + "name": "name", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", "type": "integer" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the type of the zone - core or edge", + "name": "type", + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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", + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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 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 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" - } - ], - "type": "set" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name of the group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "tag value", + "name": "value", "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 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 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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "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": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" } ], - "type": "set" + "type": "list" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Zone description", + "name": "description", "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - } - ], - "since": "4.18.0" + {} + ] }, { - "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", - "isasync": true, - "name": "deleteTemplate", + "description": "Lists all children domains belonging to a specified domain", + "isasync": false, + "name": "listDomainChildren", "params": [ { - "description": "the ID of zone of the template", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the template", + "description": "", "length": 255, - "name": "id", - "related": "listIsos,registerIso,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "Force delete a template.", - "length": 255, - "name": "forced", + "name": "pagesize", "required": false, - "since": "4.9+", - "type": "boolean" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", "type": "integer" }, - {} - ] - }, - { - "description": "Lists all network ACLs", - "isasync": false, - "name": "listNetworkACLLists", - "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list children domain by parent domain ID.", "length": 255, - "name": "account", + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", "length": 255, - "name": "page", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list network ACLs by VPC ID", + "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "list children domains by name", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" - }, + "type": "string" + } + ], + "related": "createDomain,listDomains,listDomains,moveDomain", + "response": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" }, { - "description": "Lists network ACL with the specified ID.", - "length": 255, - "name": "id", - "related": "createNetworkACLList,listNetworkACLLists", - "required": false, - "type": "uuid" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "list network ACLs by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" }, { - "description": "list network ACLs by specified name", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the domain", + "name": "id", "type": "string" - } - ], - "related": "createNetworkACLList", - "response": [ + }, { - "description": "the Name of the ACL", - "name": "name", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the ID of the ACL", - "name": "id", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "Description of the ACL", - "name": "description", - "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", @@ -64489,481 +62053,388 @@ "type": "string" }, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the level of the domain", + "name": "level", "type": "integer" }, - {}, - {}, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" - } - ] - }, - { - "description": "Archives (moves) a snapshot on primary storage to secondary storage", - "isasync": true, - "name": "archiveSnapshot", - "params": [ + }, { - "description": "The ID of the snapshot", - "length": 255, - "name": "id", - "related": "copySnapshot,archiveSnapshot,revertSnapshot,listSnapshots", - "required": true, - "type": "uuid" - } - ], - "related": "copySnapshot,revertSnapshot,listSnapshots", - "response": [ + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, - {}, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the status of the template", - "name": "status", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, + { + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, - {}, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag 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 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": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, + {}, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" - } + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + {} ] }, { - "description": "Deletes a VPC", - "isasync": true, - "name": "deleteVPC", + "description": "Returns an encrypted password for the VM", + "isasync": false, + "name": "getVMPassword", "params": [ { - "description": "the ID of the VPC", + "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "related": "assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], + "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The base64 encoded encrypted password of the VM", + "name": "encryptedpassword", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, { - "description": "Updates site to site vpn local gateway", + "description": "Assign load balancer rule or list of load balancer rules to a global load balancer rules.", "isasync": true, - "name": "updateVpnGateway", + "name": "assignToGlobalLoadBalancerRule", "params": [ { - "description": "an optional field, whether to the display the vpn to the end user or not", + "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": "fordisplay", + "name": "gslblbruleweightsmap", "required": false, - "since": "4.4", - "type": "boolean" + "type": "map" }, { - "description": "id of customer gateway", + "description": "the list load balancer rules that will be assigned to global load balancer rule", "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways,updateVpnGateway", + "name": "loadbalancerrulelist", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": true, - "type": "uuid" + "type": "list" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "required": true, + "type": "uuid" } ], - "related": "createVpnGateway,listVpnGateways", "response": [ { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the public IP address", - "name": "publicip", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "the vpc id of this gateway", - "name": "vpcid", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "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 project name", - "name": "project", - "type": "string" - }, + } + ] + }, + { + "description": "Adds S3 Image Store", + "isasync": false, + "name": "addImageStoreS3", + "params": [ { - "description": "the domain id of the owner", - "name": "domainid", + "description": "S3 endpoint", + "length": 255, + "name": "endpoint", + "required": true, "type": "string" }, - {}, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "S3 secret key", + "length": 255, + "name": "secretkey", + "required": true, "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" + "description": "Use HTTPS instead of HTTP", + "length": 255, + "name": "usehttps", + "required": false, + "type": "boolean" }, { - "description": "the owner", - "name": "account", + "description": "Name of the storage bucket", + "length": 255, + "name": "bucket", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.4" - }, - { - "description": "Releases a dedicated guest vlan range to the system", - "isasync": true, - "name": "releaseDedicatedGuestVlanRange", - "params": [ - { - "description": "the ID of the dedicated guest vlan range", + "description": "S3 access key", "length": 255, - "name": "id", - "related": "", + "name": "accesskey", "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", + "description": "Maximum number of times to retry on error", + "length": 255, + "name": "maxerrorretry", + "required": false, "type": "integer" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} - ] - }, - { - "description": "Deletes security group", - "isasync": false, - "name": "deleteSecurityGroup", - "params": [ { - "description": "The ID of the security group. Mutually exclusive with id parameter", + "description": "Whether TCP keep-alive is used", "length": 255, - "name": "name", + "name": "usetcpkeepalive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The ID of the security group. Mutually exclusive with name parameter", + "description": "Connection timeout (milliseconds)", "length": 255, - "name": "id", - "related": "createSecurityGroup", + "name": "connectiontimeout", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the domain ID of account owning the security group", + "description": "Socket timeout (milliseconds)", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "sockettimeout", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the project of the security group", + "description": "Connection TTL (milliseconds)", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "connectionttl", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the account of the security group. Must be specified with domain ID", + "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", "length": 255, - "name": "account", + "name": "s3signer", "required": false, "type": "string" } ], + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", "response": [ + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -64971,239 +62442,320 @@ "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the image store", + "name": "name", "type": "string" }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + {}, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the url of the image store", + "name": "url", + "type": "string" }, - {} - ] + { + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + } + ], + "since": "4.7.0" }, { - "description": "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool", - "isasync": true, - "name": "migrateVirtualMachine", + "description": "Upload a certificate for HTTPS direct template download on KVM hosts", + "isasync": false, + "name": "uploadTemplateDirectDownloadCertificate", "params": [ { - "description": "Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default", + "description": "Hypervisor type", "length": 255, - "name": "autoselect", - "required": false, - "since": "4.16.0", - "type": "boolean" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "the ID of the virtual machine", + "description": "SSL certificate", + "length": 65535, + "name": "certificate", + "required": true, + "type": "string" + }, + { + "description": "Name for the uploaded certificate", "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,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "description": "(optional) the host ID to upload certificate", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", "required": false, "type": "uuid" }, { - "description": "Destination Host ID to migrate VM to.", + "description": "Zone to upload certificate", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" } ], - "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,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "listTemplateDirectDownloadCertificates", "response": [ { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the direct download certificate version", + "name": "version", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, - {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the direct download certificate alias", + "name": "alias", "type": "string" }, + {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the direct download certificate issuer", + "name": "validity", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the direct download certificate id", + "name": "id", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, + {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.11.0" + }, + { + "description": "Import unmanaged virtual machine from a given cluster.", + "isasync": true, + "name": "importUnmanagedInstance", + "params": [ + { + "description": "the host name of the instance", + "length": 255, + "name": "hostname", + "required": false, "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.", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "length": 255, + "name": "datadiskofferinglist", + "required": false, + "type": "map" + }, + { + "description": "VM nic to ip address mapping using keys nic, ip4Address", + "length": 255, + "name": "nicipaddresslist", + "required": false, + "type": "map" + }, + { + "description": "the ID of the template for the virtual machine", + "length": 255, "name": "templateid", - "type": "string" + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + }, + { + "description": "import instance for the project", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" + }, + { + "description": "the display name of the instance", + "length": 255, + "name": "displayname", + "required": false, "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the instance as it is known to the hypervisor", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "used to specify the custom parameters.", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "VM nic to network id mapping using keys nic and network", + "length": 255, + "name": "nicnetworklist", + "required": false, + "type": "map" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "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": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "import instance to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" + "description": "the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + } + ], + "related": "assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { @@ -65212,33 +62764,48 @@ "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "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", @@ -65246,42 +62813,37 @@ "type": "set" }, { - "description": "the name of the security group", - "name": "name", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, { "description": "the protocol of the security group rule", "name": "protocol", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -65289,13 +62851,18 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -65304,8 +62871,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -65314,41 +62881,51 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, + { + "description": "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 type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -65359,6 +62936,78 @@ ], "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 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": "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the ID of the security group", "name": "id", @@ -65375,29 +63024,14 @@ "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", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "the ending IP of the security group rule ", "name": "endport", @@ -65409,8 +63043,13 @@ "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -65419,8 +63058,18 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "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" }, { @@ -65433,18 +63082,18 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -65453,277 +63102,176 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { "description": "the domain associated with the tag", "name": "domain", "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the 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 project name where tag belongs to", - "name": "project", - "type": "string" } ], "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" } ], "type": "set" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, + {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, { "description": " an alternate display text of the template for the virtual machine", "name": "templatedisplaytext", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "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 type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, { "description": "the list of nics associated with vm", "name": "nic", @@ -65734,59 +63282,69 @@ "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "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", + "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 isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "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 Secondary ipv4 addr of nic", @@ -65794,28 +63352,33 @@ "type": "list" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -65824,1299 +63387,1243 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "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": "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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" } ], "type": "set" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, + {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the 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 affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the account owning the affinity group", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain name of the affinity group", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "tag value", + "name": "value", "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "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 userdata used for the VM", - "name": "userdataname", + "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", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" - } - ] - }, - { - "description": "Deletes a Kubernetes cluster", - "isasync": true, - "name": "deleteKubernetesSupportedVersion", - "params": [ + }, { - "description": "the ID of the Kubernetes supported version", - "length": 255, - "name": "id", - "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it.", - "isasync": true, - "name": "createTemplate", - "params": [ + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, { - "description": "true if this template is a featured template, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", - "length": 255, - "name": "snapshotid", - "related": "copySnapshot,revertSnapshot,listSnapshots", - "required": false, - "type": "uuid" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "true if the template requires HVM, false otherwise", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server", - "length": 2048, - "name": "url", - "required": false, + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, + "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", "name": "isdynamicallyscalable", - "required": false, "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "since": "4.19.0", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "type": "uuid" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, + "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": "32 or 64 bit", - "length": 255, - "name": "bits", - "required": false, - "type": "integer" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "create template for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the zone for the template. Can be specified with snapshot only", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + } + ], + "since": "4.14.0" + }, + { + "description": "Creates a physical network", + "isasync": true, + "name": "createPhysicalNetwork", + "params": [ + { + "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "broadcastdomainrange", "required": false, - "since": "4.19.0", - "type": "uuid" + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", + "description": "the Zone ID for the physical network", "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the name of the template", + "description": "the name of the physical network", "length": 255, "name": "name", "required": true, "type": "string" }, { - "description": "The display text of the template, defaults to the 'name'.", - "length": 4096, - "name": "displaytext", + "description": "the VLAN for the physical network", + "length": 255, + "name": "vlan", "required": false, "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "Tag the physical network", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "tags", "required": false, - "since": "4.19.0", - "type": "uuid" + "type": "list" }, { - "description": "the ID of the OS Type that best represents the OS of this template.", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "ostypeid", - "related": "listOsTypes,addGuestOs", - "required": true, + "name": "networkspeed", + "required": false, + "type": "string" + }, + { + "description": "domain ID of the account owning a physical network", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, "type": "uuid" + }, + { + "description": "the isolation method for the physical network[VLAN/L3/GRE]", + "length": 255, + "name": "isolationmethods", + "required": false, + "type": "list" } ], - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "response": [ { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the speed of the physical network", + "name": "networkspeed", "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": "the URL which the template/iso is registered from", - "name": "url", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, + {}, + {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the uuid of the physical network", + "name": "id", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "name of the physical network", + "name": "name", + "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "state of the physical network", + "name": "state", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists autoscale vm groups.", + "isasync": false, + "name": "listAutoScaleVmGroups", + "params": [ + { + "description": "the ID of the profile", + "length": 255, + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": false, + "type": "uuid" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the name of the autoscale vmgroup", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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": "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "the ID of the policy", + "length": 255, + "name": "policyid", + "related": "listAutoScalePolicies", + "required": false, + "type": "uuid" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" + "description": "the ID of the loadbalancer", + "length": 255, + "name": "lbruleid", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": false, + "type": "uuid" }, { - "description": "the template ID", - "name": "id", - "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": "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 autoscale vm group", + "length": 255, + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "required": false, + "type": "uuid" + } + ], + "related": "enableAutoScaleVmGroup", + "response": [ + { + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", + "name": "minmembers", + "type": "int" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "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", + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", "type": "list" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "the public ip address", + "name": "publicip", "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 account id to which the template belongs", - "name": "accountid", + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", "type": "int" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "is group for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", + "type": "string" }, - {}, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the public port", + "name": "publicport", + "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - } - ] - }, - { - "description": "list baremetal rack configuration", - "isasync": false, - "name": "listBaremetalRct", - "params": [ + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "addBaremetalRct", - "response": [ - { - "description": "url", - "name": "url", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, - {}, { - "description": "id of rct", - "name": "id", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the vm group", + "name": "account", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, { - "description": "Lists dedicated clusters.", + "description": "Updates a Pod.", "isasync": false, - "name": "listDedicatedClusters", + "name": "updatePod", "params": [ { - "description": "", + "description": "the ending IP address for the Pod", "length": 255, - "name": "page", + "name": "endip", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the cluster", + "description": "the netmask of the Pod", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "netmask", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list dedicated clusters by affinity group", + "description": "the name of the Pod", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the gateway for the Pod", "length": 255, - "name": "keyword", + "name": "gateway", "required": false, "type": "string" }, { - "description": "", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "pagesize", + "name": "allocationstate", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the domain associated with the cluster", + "description": "the starting IP address for the Pod", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "startip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the account associated with the cluster. Must be used with domainId.", + "description": "the ID of the Pod", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "id", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "createPod,listPods,createManagementNetworkIpRange", "response": [ { - "description": "the name of the cluster", - "name": "clustername", - "type": "string" - }, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the cluster", - "name": "clusterid", - "type": "string" - }, - { - "description": "the domain ID of the cluster", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" }, { - "description": "the Dedication Affinity Group ID of the cluster", - "name": "affinitygroupid", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, - {}, - { - "description": "the Account ID of the cluster", - "name": "accountid", - "type": "string" - } - ] - }, - { - "description": "Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.", - "isasync": true, - "name": "uploadCustomCertificate", - "params": [ { - "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", - "length": 255, - "name": "id", - "required": false, - "type": "integer" + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + } + ], + "type": "list" }, { - "description": "The certificate to be uploaded.", - "length": 65535, - "name": "certificate", - "required": true, + "description": "the netmask of the Pod", + "name": "netmask", "type": "string" }, { - "description": "A name / alias for the certificate.", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, { - "description": "DNS domain suffix that the certificate is granted for.", - "length": 255, - "name": "domainsuffix", - "required": true, + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { - "description": "The private key for the attached certificate.", - "length": 65535, - "name": "privatekey", - "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 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": "message of the certificate upload operation", - "name": "message", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, - {} - ] - }, - { - "description": "Lists available certificate authority providers in CloudStack", - "isasync": false, - "name": "listCAProviders", - "params": [ { - "description": "List CA service provider by name", - "length": 255, - "name": "name", - "required": false, + "description": "the Zone ID of the Pod", + "name": "zoneid", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the CA service provider name", - "name": "name", - "type": "string" + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Pod", + "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + } + ], + "type": "list" }, { - "description": "the description of the CA service provider", - "name": "description", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, - {}, - {} - ], - "since": "4.11.0" - }, - { - "description": "Delete site to site vpn customer gateway", - "isasync": true, - "name": "deleteVpnCustomerGateway", - "params": [ { - "description": "id of customer gateway", - "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "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": "Lists all port forwarding rules for an IP address.", - "isasync": false, - "name": "listPortForwardingRules", + "description": "Attaches an ISO to a virtual machine.", + "isasync": true, + "name": "attachIso", "params": [ { - "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", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.3", - "type": "uuid" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "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; if projectid=-1 lists All VMs", - "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", - "required": false, - "type": "string" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the virtual machine", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "name": "virtualmachineid", + "related": "assignVirtualMachine,attachIso,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, "type": "uuid" }, { - "description": "the ID of IP address of the port forwarding services", + "description": "the ID of the ISO file", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "If true, ejects existing ISO before attaching on VMware. Default: false", "length": 255, - "name": "listall", + "name": "forced", "required": false, + "since": "4.15.1", "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "Lists rule with the specified ID.", - "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule,listPortForwardingRules,updatePortForwardingRule", - "required": false, - "type": "uuid" } ], - "related": "updateIpv6FirewallRule,updatePortForwardingRule", + "related": "assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "response": [ { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "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 id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the list of resource tags associated with the rule", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -67125,520 +64632,83 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], - "type": "list" - } - ] - }, - { - "description": "Allocates IP addresses in respective Pod of a Zone", - "isasync": false, - "name": "acquirePodIpAddress", - "params": [ + "type": "set" + }, { - "description": "the ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Pod ID", - "length": 255, - "name": "podid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the ID of the pod the IP address", - "name": "id", - "type": "long" - }, - { - "description": "Gateway for Pod ", - "name": "gateway", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "nicid", - "type": "long" - }, - { - "description": "the ID of the pod the IP address belongs to", - "name": "podid", - "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": "CIDR of the Pod", - "name": "cidr", - "type": "string" - }, - { - "description": "MAC address of the pod the IP", - "name": "hostmac", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, - {}, - {}, - { - "description": "Allocated IP address", - "name": "ipaddress", - "type": "string" - } - ] - }, - { - "description": "Enables out-of-band management for a cluster", - "isasync": true, - "name": "enableOutOfBandManagementForCluster", - "params": [ - { - "description": "the ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", - "response": [ - { - "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": "the ID of the host", - "name": "hostid", - "type": "string" - }, - {}, - { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the operation result description", - "name": "description", - "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 username", - "name": "username", - "type": "string" - }, - { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.9.0" - }, - { - "description": "list Tungsten-Fabric network", - "isasync": false, - "name": "listTungstenFabricNetwork", - "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the uuid of Tungsten-Fabric network", - "length": 255, - "name": "networkuuid", - "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 include public network. Default value is false", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - } - ], - "related": "", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Tungsten-Fabric network name", - "name": "name", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", + "description": "the name of the availability zone for the virtual machine", "name": "zonename", "type": "string" }, - {}, - {}, - { - "description": "Tungsten-Fabric network uuid", - "name": "uuid", - "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Updates a template visibility permissions. A public template is visible to all accounts within the same domain. A private template is visible only to the owner of the template. A privileged template is a private template with account permissions added. Only accounts specified under the template permissions are visible to them.", - "isasync": false, - "name": "updateTemplatePermissions", - "params": [ - { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "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,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "true for public template/iso, false for private templates/isos", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, - { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" - }, - { - "description": "permission operator (add, remove, reset)", - "length": 255, - "name": "op", - "required": false, - "type": "string" - }, - { - "description": "true for featured template/iso, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} - ] - }, - { - "description": "List traffic monitor Hosts.", - "isasync": false, - "name": "listTrafficMonitors", - "params": [ - { - "description": "zone Id", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "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" - } - ], - "related": "addTrafficMonitor", - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the external firewall", - "name": "id", - "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 timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" - } - ] - }, - { - "description": "Resets the password for virtual machine. The virtual machine must be in a \"Stopped\" state and the template must already support this feature for this command to take effect. [async]", - "isasync": true, - "name": "resetPasswordForVirtualMachine", - "params": [ - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - }, - { - "description": "The new password of the virtual machine. If null, a random password will be generated for the VM.", - "length": 255, - "name": "password", - "required": false, - "since": "4.19.0", - "type": "string" - } - ], - "related": "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "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 project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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": "ssh key-pairs", - "name": "keypairs", - "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": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, { "description": "the project id of the group", "name": "projectid", @@ -67649,28 +64719,33 @@ "name": "virtualmachinecount", "type": "integer" }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -67679,8 +64754,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -67689,60 +64764,40 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -67751,37 +64806,47 @@ "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "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 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": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -67794,14 +64859,24 @@ "name": "domain", "type": "string" }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -67810,68 +64885,33 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" } ], "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", + "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": "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", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -67880,9 +64920,9 @@ "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", @@ -67890,8 +64930,8 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -67899,13 +64939,13 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -67914,403 +64954,295 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { "description": "tag value", "name": "value", "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" } ], "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "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", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project name of the group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "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": "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "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", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the 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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ID of the nic", + "description": "the ID of the affinity group", "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the name of the affinity group", + "name": "name", + "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the 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 virtual machine", - "name": "name", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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 name who deployed the virtual machine", + "name": "username", + "type": "string" }, { "description": "the user's ID who deployed the virtual machine", @@ -68318,28 +65250,33 @@ "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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 project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { @@ -68348,68 +65285,64 @@ "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -68418,304 +65351,458 @@ "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, - {}, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the type of the affinity group", + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the 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 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": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" } ], "type": "set" }, + {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, - {}, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, { "description": "VNF details", "name": "vnfdetails", "type": "map" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + } + ] + }, + { + "description": "(Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site.", + "isasync": false, + "name": "ldapRemove", + "params": [], + "related": "", + "response": [ + { + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", "type": "string" }, + {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Specify the LDAP port if required, default is 389", + "name": "port", + "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com", + "name": "searchbase", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "DN password", + "name": "bindpass", "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" } - ] + ], + "since": "3.0.1" }, { - "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", - "isasync": true, - "name": "updatePortForwardingRule", + "description": "Creates a user for an account that already exists", + "isasync": false, + "name": "createUser", "params": [ { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "lastname", "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,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "lastname", + "required": true, + "type": "string" + }, + { + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "the ID of the port forwarding rule", + "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": "id", - "related": "updateIpv6FirewallRule,updatePortForwardingRule", + "name": "account", "required": true, - "since": "4.4", - "type": "uuid" + "type": "string" }, { - "description": "the private start port of the port forwarding rule", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "privateport", + "name": "timezone", "required": false, - "type": "integer" + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "email", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "email", + "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", + "description": "firstname", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "name": "firstname", + "required": true, "type": "string" }, { - "description": "VM guest nic Secondary ip address for the port forwarding rule", + "description": "Unique username.", "length": 255, - "name": "vmguestip", - "required": false, - "since": "4.5", + "name": "username", + "required": true, "type": "string" }, { - "description": "the private end port of the port forwarding rule", + "description": "User UUID, required for adding account from external provisioning system", "length": 255, - "name": "privateendport", + "name": "userid", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "length": 255, + "name": "password", + "required": true, + "type": "string" } ], - "related": "updateIpv6FirewallRule", + "related": "disableUser,getUser,listUsers,lockUser", "response": [ - {}, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, {}, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -68724,248 +65811,205 @@ "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "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 ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "list" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", + "description": "the date and time the user 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": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" - } + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + {} ] }, { - "description": "Lists Brocade VCS Switches", - "isasync": false, - "name": "listBrocadeVcsDevices", + "description": "Creates site to site vpn local gateway", + "isasync": true, + "name": "createVpnGateway", "params": [ { - "description": "Brocade VCS switch ID", - "length": 255, - "name": "vcsdeviceid", - "related": "listBrocadeVcsDevices", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "the Physical Network ID", + "description": "public ip address id of the vpn gateway", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": true, "type": "uuid" + } + ], + "related": "updateVpnGateway", + "response": [ + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the vpc name of this gateway", + "name": "vpcname", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the public IP address", + "name": "publicip", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "name of the provider", - "name": "provider", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id", + "name": "projectid", "type": "string" }, + { + "description": "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": "device id of the Brocade Vcs", - "name": "vcsdeviceid", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "device name", - "name": "brocadedevicename", + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the principal switch Ip address", - "name": "hostname", + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" + }, + {}, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" } ] }, { - "description": "link an existing cloudstack domain to group or OU in ldap", - "isasync": false, - "name": "linkDomainToLdap", + "description": "Adds detail for the Resource.", + "isasync": true, + "name": "addResourceDetail", "params": [ { - "description": "The id of the domain which has to be linked to LDAP.", + "description": "Map of (key/value pairs)", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "details", "required": true, - "type": "uuid" - }, - { - "description": "domain admin username in LDAP ", - "length": 255, - "name": "admin", - "required": false, - "type": "string" + "type": "map" }, { - "description": "type of the ldap name. GROUP or OU", + "description": "type of the resource", "length": 255, - "name": "type", + "name": "resourcetype", "required": true, "type": "string" }, { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "description": "resource id to create the details for", "length": 255, - "name": "accounttype", + "name": "resourceid", "required": true, - "type": "integer" + "type": "string" }, { - "description": "name of the group or OU in LDAP", + "description": "pass false if you want this detail to be disabled for the regular user. True by default", "length": 255, - "name": "ldapdomain", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" } ], - "related": "linkAccountToLdap", "response": [ { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" - }, - { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", - "type": "string" - }, - { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -68974,435 +66018,371 @@ "type": "string" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", - "type": "string" - }, - { - "description": "Domain Admin accountId that is created", - "name": "accountid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, {} - ], - "since": "4.6.0" + ] }, { - "description": "Acquires and associates a public IP to an account.", - "isasync": true, - "name": "associateIpAddress", + "description": "Lists vpn users", + "isasync": false, + "name": "listVpnUsers", "params": [ { - "description": "the ID of the domain to associate with this IP address", + "description": "the username of the vpn user.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Deploy VM for the project", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the availability zone you want to acquire an public IP address from", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "the account to associate with this IP address", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isportable", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "the VPC you want the IP address to be associated with", + "description": "The uuid of the Vpn user", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "id", + "related": "addVpnUser,listVpnUsers", "required": false, "type": "uuid" }, { - "description": "The network this IP address should be associated to.", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "IP Address to be associated", + "description": "List by keyword", "length": 255, - "name": "ipaddress", + "name": "keyword", "required": false, "type": "string" }, { - "description": "region ID from where portable IP is to be associated.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "fordisplay", + "name": "projectid", + "related": "activateProject,createProject", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" } ], - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "related": "addVpnUser", "response": [ { - "description": "public IP address", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" - }, - { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "the vpn userID", + "name": "id", "type": "string" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the username of the vpn user", + "name": "username", "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": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", - "type": "string" - }, - { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the ipaddress", + "description": "the project id of the vpn", "name": "projectid", "type": "string" }, + {} + ] + }, + { + "description": "Deletes an IP forwarding rule", + "isasync": true, + "name": "deleteIpForwardingRule", + "params": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, + "description": "the ID of the forwarding rule", + "length": 255, + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" - }, - { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Register a new userdata.", + "isasync": false, + "name": "registerUserData", + "params": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Base64 encoded userdata content. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": true, "type": "string" }, { - "description": "the domain ID the public IP address is associated with", + "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "length": 255, "name": "domainid", - "type": "string" - }, - { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "an optional project for the userdata", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject", + "required": false, + "type": "uuid" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "Name of the userdata", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "comma separated list of variables declared in userdata content", + "length": 255, + "name": "params", + "required": false, "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, + } + ], + "response": [ { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "any text associated with the success or failure", + "name": "displaytext", "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": "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", - "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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "list" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "public IP address id", - "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 Network where ip belongs to", - "name": "networkname", - "type": "string" - } - ] + {} + ], + "since": "4.18" }, { - "description": "Get the SF Volume Access Group IDs", + "description": "Adds a Region", "isasync": false, - "name": "getSolidFireVolumeAccessGroupIds", + "name": "addRegion", "params": [ { - "description": "Storage Pool UUID", + "description": "Name of the region", "length": 255, - "name": "storageid", + "name": "name", "required": true, "type": "string" }, { - "description": "Cluster UUID", + "description": "Region service endpoint", "length": 255, - "name": "clusterid", + "name": "endpoint", "required": true, "type": "string" + }, + { + "description": "Id of the Region", + "length": 255, + "name": "id", + "required": true, + "type": "integer" } ], - "related": "", + "related": "updateRegion", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the name of the region", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the ID of the region", + "name": "id", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, { - "description": "SolidFire Volume Access Group Ids", - "name": "solidFireVolumeAccessGroupIds", - "type": "long[]" + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" + }, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { - "description": "Setup the 2FA for the user.", + "description": "Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed", "isasync": false, - "name": "setupUserTwoFactorAuthentication", + "name": "generateUsageRecords", "params": [ { - "description": "optional: the id of the user for which 2FA has to be disabled", + "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": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "two factor authentication code", + "description": "List events for the specified domain.", "length": 255, - "name": "provider", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Enabled by default, provide false to disable 2FA", + "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": "enable", + "name": "enddate", "required": false, - "type": "boolean" + "type": "date" } ], - "related": "", "response": [ + {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the user name", - "name": "username", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -69411,1232 +66391,833 @@ "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "secret code that needs to be registered with authenticator", - "name": "secretcode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} - ], - "since": "4.18.0" + } + ] }, { - "description": "Delete site to site vpn connection", - "isasync": true, - "name": "deleteVpnConnection", + "description": "Updates a role permission order", + "isasync": false, + "name": "updateRolePermission", "params": [ { - "description": "id of vpn connection", + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections", + "name": "ruleorder", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "Role permission rule id", + "length": 255, + "name": "ruleid", + "related": "", + "required": false, + "since": "4.11", + "type": "uuid" + }, + { + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": true, "type": "uuid" + }, + { + "description": "Rule permission, can be: allow or deny", + "length": 255, + "name": "permission", + "required": false, + "since": "4.11", + "type": "string" } ], "response": [ - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "Creates a ACL rule in the given network (the network has to belong to VPC)", - "isasync": true, - "name": "createNetworkACL", + "description": "Lists accounts and provides detailed account information for listed accounts", + "isasync": false, + "name": "listAccounts", "params": [ { - "description": "the ending port of ACL", + "description": "list account by account name", "length": 255, - "name": "endport", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "error code for this ICMP message", + "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "icmpcode", + "name": "details", + "required": false, + "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": "integer" }, { - "description": "The network of the VM the ACL will be created for", + "description": "list account by account ID", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "Tag for resource type to return usage", "length": 255, - "name": "reason", + "name": "tag", "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "flag to display the resource icon for accounts", "length": 255, - "name": "fordisplay", + "name": "showicon", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "The network of the VM the ACL will be created for", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "scl entry action, allow or deny", + "description": "list accounts by cleanuprequired attribute (values are true or false)", "length": 255, - "name": "action", + "name": "iscleanuprequired", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", + "description": "", "length": 255, - "name": "traffictype", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the starting port of ACL", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "startport", + "name": "isrecursive", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "type of the ICMP message being sent", + "description": "List by keyword", "length": 255, - "name": "icmptype", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "", "length": 255, - "name": "cidrlist", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { - "description": "The number of the ACL item, its ordering", + "description": "list accounts by state. Valid states are enabled, disabled, and locked.", "length": 255, - "name": "number", + "name": "state", "required": false, - "type": "integer" + "type": "string" } ], - "related": "updateNetworkACLItem,moveNetworkAclItem", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "response": [ { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "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 network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "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 total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "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 secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the account associated with the tag", + "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 email address", + "name": "email", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the account name of the user", "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the domain ID of the user", "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the user ID", + "name": "id", + "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 user name", + "name": "username", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" } ], "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the protocol of the ACL", - "name": "protocol", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, {}, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", - "type": "string" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Number of the ACL Item", - "name": "number", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, - {} - ] - }, - { - "description": "Resets the SSH Key for virtual machine. The virtual machine must be in a \"Stopped\" state. [async]", - "isasync": true, - "name": "resetSSHKeyForVirtualMachine", - "params": [ { - "description": "name of the ssh key pair used to login to the virtual machine", - "length": 255, - "name": "keypair", - "required": false, + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "names of the ssh key pairs to be used to login to the virtual machine", - "length": 255, - "name": "keypairs", - "required": false, - "since": "4.17", - "type": "list" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "an optional account for the ssh key. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "description": "the name of the role", + "name": "rolename", + "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": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "an optional project for the ssh key", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - } - ], - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, + {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the 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", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" + } + ] + }, + { + "description": "Destroys a router.", + "isasync": true, + "name": "destroyRouter", + "params": [ + { + "description": "the ID of the router", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the router", + "name": "name", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" } ], - "type": "set" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "type": "list" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the ID of the 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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the 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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag 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 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": "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" - } - ], - "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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "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": "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 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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the 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": "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": "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" - } - ], - "type": "set" - }, - { - "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 id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { "description": "the Secondary ipv4 addr of nic", @@ -70644,33 +67225,13 @@ "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 IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -70679,8 +67240,8 @@ "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -70689,218 +67250,141 @@ "type": "boolean" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, { "description": "the isolated private VLAN if available", "name": "isolatedpvlan", "type": "integer" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" } ], "type": "set" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" - } - ] - }, - { - "description": "Lists site to site vpn customer gateways", - "isasync": false, - "name": "listVpnCustomerGateways", - "params": [ - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" }, { - "description": "id of the customer gateway", - "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the project name of the address", + "name": "project", "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. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the domain associated with the router", + "name": "domain", "type": "string" - } - ], - "related": "createVpnCustomerGateway", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the owner", + "description": "the account associated with the router", "name": "account", "type": "string" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" }, - {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { @@ -70909,14 +67393,14 @@ "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -70924,214 +67408,173 @@ "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "role of the domain router", + "name": "role", "type": "string" }, + {}, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" }, - {}, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, { - "description": "name of the customer gateway", - "name": "name", - "type": "string" - }, - { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the project name", - "name": "project", - "type": "string" - } - ] - }, - { - "description": "Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated.", - "isasync": true, - "name": "deleteManagementNetworkIpRange", - "params": [ - { - "description": "The vlan id the ip range sits on", - "length": 255, - "name": "vlan", - "required": true, + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "The starting IP address.", - "length": 255, - "name": "startip", - "required": true, + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "The ending IP address.", - "length": 255, - "name": "endip", - "required": true, + "description": "the template ID for the router", + "name": "templateid", "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, {}, - {}, { - "description": "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" } - ], - "since": "4.11.0.0" + ] }, { - "description": "Add a supported Kubernetes version", + "description": "Lists image stores.", "isasync": false, - "name": "addKubernetesSupportedVersion", + "name": "listImageStores", "params": [ { - "description": "the name of the Kubernetes supported version", + "description": "the ID of the storage pool", "length": 255, - "name": "name", + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "required": false, + "type": "uuid" + }, + { + "description": "the image store provider", + "length": 255, + "name": "provider", "required": false, "type": "string" }, { - "description": "If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false", + "description": "", "length": 255, - "name": "directdownload", + "name": "page", "required": false, - "since": "4.18.2", - "type": "boolean" + "type": "integer" }, { - "description": "the URL of the binaries ISO for Kubernetes supported version", + "description": "the name of the image store", "length": 255, - "name": "url", + "name": "name", "required": false, "type": "string" }, { - "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", + "description": "List by keyword", "length": 255, - "name": "semanticversion", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "the Zone ID for the image store", "length": 255, "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "description": "read-only status of the image store", "length": 255, - "name": "minmemory", - "required": true, - "type": "integer" + "name": "readonly", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", + "required": false, + "since": "4.15.0", + "type": "boolean" }, { - "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "the image store protocol", "length": 255, - "name": "checksum", + "name": "protocol", "required": false, "type": "string" }, { - "description": "the minimum number of CPUs to be set with the Kubernetes version", + "description": "", "length": 255, - "name": "mincpunumber", - "required": true, + "name": "pagesize", + "required": false, "type": "integer" } ], - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore", "response": [ { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "type": "string" - }, - { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" - }, - { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", - "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", @@ -71139,673 +67582,425 @@ "type": "string" }, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the name of the image store", + "name": "name", "type": "string" }, + {}, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, - {}, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, + {}, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the provider name of the image store", + "name": "providername", "type": "string" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", - "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 in which Kubernetes supported version is available", - "name": "zonename", + "description": "the url of the image store", + "name": "url", "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Deletes a Kubernetes cluster", + "description": "Deletes a account, and all users associated with this account", "isasync": true, - "name": "deleteKubernetesCluster", + "name": "deleteAccount", "params": [ { - "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", - "length": 255, - "name": "expunge", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, - { - "description": "the ID of the Kubernetes cluster", + "description": "Account id", "length": 255, "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "required": true, "type": "uuid" - }, - { - "description": "Destroy attached instances of the ExternalManaged Cluster. Default: false", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.19.0", - "type": "boolean" } ], "response": [ + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { "description": "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": "Creates a global load balancer rule", + "description": "Disables out-of-band management for a cluster", "isasync": true, - "name": "createGlobalLoadBalancerRule", + "name": "disableOutOfBandManagementForCluster", "params": [ { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", - "required": false, - "type": "string" - }, - { - "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "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": "session sticky method (sourceip) if not specified defaults to sourceip", - "length": 255, - "name": "gslbstickysessionmethodname", - "required": false, - "type": "string" - }, - { - "description": "region where the global load balancer is going to be created.", + "description": "the ID of the cluster", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, - "type": "integer" - }, - { - "description": "the domain ID associated with the load balancer", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, "type": "uuid" - }, - { - "description": "GSLB service type (tcp, udp, http)", - "length": 255, - "name": "gslbservicetype", - "required": true, - "type": "string" - }, - { - "description": "domain name for the GSLB service.", - "length": 255, - "name": "gslbdomainname", - "required": true, - "type": "string" } ], - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "related": "enableOutOfBandManagementForHost,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "global load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "the operation result", + "name": "status", + "type": "boolean" }, - {}, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "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": "the domain ID of the load balancer rule", - "name": "domainid", - "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", + "type": "boolean" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, + {}, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "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 id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "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 id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "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 domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the list of resource tags associated with load balancer", - "name": "tags", - "response": [ - { - "description": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "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 project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" - }, - {} - ] + } + ], + "since": "4.9.0" }, { - "description": "Link or unlink a userdata to a template.", - "isasync": false, - "name": "linkUserDataToTemplate", + "description": "Activates a project", + "isasync": true, + "name": "activateProject", "params": [ { - "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", - "length": 255, - "name": "userdatapolicy", - "required": false, - "type": "string" - }, - { - "description": "the ID of the ISO for the virtual machine", - "length": 255, - "name": "isoid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO", + "description": "id of the project to be modified", "length": 255, - "name": "userdataid", - "related": "", - "required": false, + "name": "id", + "related": "activateProject,createProject", + "required": true, "type": "uuid" } ], - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "createProject", "response": [ { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "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", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, + {}, + {}, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the template ID", + "description": "the id of the project", "name": "id", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "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", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "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 secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the project name of the template", - "name": "project", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, - {}, { - "description": "the status of the template", - "name": "status", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the domain id the project belongs to", + "name": "domainid", + "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 total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of resource tags associated", + "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": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -71814,23 +68009,23 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -71843,439 +68038,349 @@ "name": "account", "type": "string" }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, { "description": "tag value", "name": "value", "type": "string" + }, + { + "description": "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" + "type": "list" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" - }, + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + } + ], + "since": "3.0.0" + }, + { + "description": "Delete a certificate to CloudStack", + "isasync": false, + "name": "deleteSslCert", + "params": [ { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "Id of SSL certificate", + "length": 255, + "name": "id", + "related": "uploadSslCert", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, + } + ] + }, + { + "description": "Delete one or more alerts.", + "isasync": false, + "name": "deleteAlerts", + "params": [ { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "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": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the IDs of the alerts", + "length": 255, + "name": "ids", + "related": "listAlerts,listAlertTypes", + "required": false, + "type": "list" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - } - ], - "since": "4.18.0" - }, - { - "description": " delete a netscaler load balancer device", - "isasync": true, - "name": "deleteNetscalerLoadBalancer", - "params": [ - { - "description": "netscaler load balancer device ID", + "description": "delete by alert type", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, - "type": "uuid" + "name": "type", + "required": false, + "type": "string" } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {}, { "description": "the current status 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": "Lists load balancer rules.", - "isasync": false, - "name": "listGlobalLoadBalancerRules", + "description": "Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.", + "isasync": true, + "name": "createAutoScaleVmProfile", "params": [ { - "description": "", + "description": "the ID of the Userdata", "length": 255, - "name": "pagesize", + "name": "userdataid", + "related": "", "required": false, - "type": "integer" + "since": "4.18.1", + "type": "uuid" }, { - "description": "the ID of the global load balancer rule", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "id", - "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "", + "description": "the service offering of the auto deployed virtual machine", "length": 255, - "name": "page", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", "required": false, - "type": "integer" + "since": "4.18.0", + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the template of the auto deployed virtual machine", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the user used to launch and destroy the VMs", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, "type": "uuid" }, { - "description": "region ID", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "userdatadetails", "required": false, - "type": "integer" + "since": "4.18.1", + "type": "map" }, { - "description": "list only resources belonging to the domain specified", + "description": "domain ID of the account owning a autoscale VM profile", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", "length": 255, - "name": "tags", + "name": "counterparam", "required": false, "type": "map" }, { - "description": "List by keyword", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "the time allowed for existing connections to get closed before a vm is expunged", "length": 255, - "name": "listall", + "name": "expungevmgraceperiod", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "account that will own the autoscale VM profile", "length": 255, "name": "account", "required": false, "type": "string" + }, + { + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "length": 255, + "name": "otherdeployparams", + "required": false, + "type": "map" + }, + { + "description": "an optional project for the autoscale VM profile", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" } ], - "related": "updateGlobalLoadBalancerRule", + "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", "response": [ + { + "description": "Base64 encoded VM user data", + "name": "userdata", + "type": "string" + }, {}, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", "type": "integer" }, { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, - {}, { - "description": "the domain of the load balancer rule", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the domain name of the vm profile", "name": "domain", "type": "string" }, { - "description": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", - "response": [ - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the domain of the load balancer rule", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the list of resource tags associated with load balancer", - "name": "tags", - "response": [ - { - "description": "the 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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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": "list" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", - "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": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - } - ], - "type": "list" + "description": "the domain ID of the vm profile", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", + "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": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { @@ -72284,96 +68389,96 @@ "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, + {}, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" } ] }, { - "description": "Release the dedication for cluster", - "isasync": true, - "name": "releaseDedicatedCluster", + "description": "Register the OAuth2 provider in CloudStack", + "isasync": false, + "name": "registerOauthProvider", "params": [ { - "description": "the ID of the Cluster", + "description": "Name of the provider from the list of OAuth providers supported in CloudStack", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "provider", "required": true, - "type": "uuid" - } - ], - "response": [ + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Description of the OAuth Provider", + "length": 255, + "name": "description", + "required": true, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Secret Key pre-registered in the specific OAuth provider", + "length": 255, + "name": "secretkey", + "required": true, + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Redirect URI pre-registered in the specific OAuth provider", + "length": 255, + "name": "redirecturi", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, - {}, - {} - ] - }, - { - "description": "Updates a disk offering.", - "isasync": false, - "name": "deleteDiskOffering", - "params": [ { - "description": "ID of the disk offering", + "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", + "name": "clientid", "required": true, - "type": "uuid" + "type": "string" } ], "response": [ - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, { @@ -72382,49 +68487,26 @@ "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.19.0" }, { - "description": "List resource tag(s)", + "description": "Lists load balancer stickiness policies.", "isasync": false, - "name": "listTags", + "name": "listLBStickinessPolicies", "params": [ { - "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": "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 customer name", + "description": "the ID of the load balancer rule", "length": 255, - "name": "customer", + "name": "lbruleid", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -72434,18 +68516,19 @@ "type": "integer" }, { - "description": "", + "description": "the ID of the load balancer stickiness policy", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list by resource type", + "description": "", "length": 255, - "name": "resourcetype", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "List by keyword", @@ -72455,75 +68538,35 @@ "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "list by value", - "length": 255, - "name": "value", - "required": false, - "type": "string" - }, - { - "description": "list by resource id", - "length": 255, - "name": "resourceid", - "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": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "listall", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" } ], - "related": "", + "related": "createLBStickinessPolicy,updateLBStickinessPolicy", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "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 account associated with the tag", - "name": "account", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, - {}, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, { @@ -72532,58 +68575,129 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", + "response": [ + { + "description": "the LB Stickiness policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" + }, + { + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the params of the policy", + "name": "params", + "type": "map" + }, + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + } + ], + "type": "list" + }, + {}, + { + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" } ], - "since": "4.0.0" + "since": "3.0.0" }, { - "description": "Get Kubernetes cluster config", + "description": "Adds a Ucs manager", "isasync": false, - "name": "getKubernetesClusterConfig", + "name": "addUcsManager", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "the Zone id for the ucs manager", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" + }, + { + "description": "the password of UCS", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "the name of UCS url", + "length": 255, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "the name of UCS manager", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the username of UCS", + "length": 255, + "name": "username", + "required": true, + "type": "string" } ], - "related": "", + "related": "listUcsManagers", "response": [ {}, { - "description": "the id of the container cluster", + "description": "the ID of the ucs manager", "name": "id", "type": "string" }, { - "description": "the config data of the cluster", - "name": "configdata", + "description": "the name of ucs manager", + "name": "name", "type": "string" }, { @@ -72596,586 +68710,644 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the url of ucs manager", + "name": "url", + "type": "string" + }, {}, { - "description": "Name of the container cluster", - "name": "name", + "description": "the zone ID of ucs manager", + "name": "zoneid", "type": "string" } ] }, { - "description": "Create a virtual router element.", + "description": "Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected.", "isasync": true, - "name": "createVirtualRouterElement", + "name": "deleteVnfTemplate", "params": [ { - "description": "The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter", + "description": "Force delete a template.", "length": 255, - "name": "providertype", - "related": "listNetworkServiceProviders", + "name": "forced", + "required": false, + "since": "4.9+", + "type": "boolean" + }, + { + "description": "Necessary if the template's type is system.", + "length": 255, + "name": "issystem", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the network service provider ID of the virtual router element", + "description": "the ID of the template", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" } ], - "related": "configureVirtualRouterElement,listVirtualRouterElements", "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 physical network service provider id of the provider", - "name": "nspid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ], + "since": "4.19.0" + }, + { + "description": "lists netscaler load balancer devices", + "isasync": false, + "name": "listNetscalerLoadBalancers", + "params": [ { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", - "type": "string" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, - {}, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "required": false, + "type": "uuid" }, { - "description": "the account associated with the provider", - "name": "account", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", + "response": [ + { + "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": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", "type": "boolean" }, { - "description": "the id of the router", - "name": "id", + "description": "name of the provider", + "name": "provider", "type": "string" - } - ] - }, - { - "description": "Creates a VPC", - "isasync": true, - "name": "createVPC", - "params": [ + }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "length": 255, - "name": "dns1", - "required": false, - "since": "4.18.0", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "VPC network domain. All networks inside the VPC will belong to this domain", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "IPV4 address to be assigned to the public interface of the network router.This address will be used as source NAT address for the networks in ths VPC. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", - "length": 255, - "name": "sourcenatipaddress", - "required": false, - "since": "4.19", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "length": 255, - "name": "ip6dns1", - "required": false, - "since": "4.18.0", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "an optional field, whether to the display the vpc to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, { - "description": "The display text of the VPC, defaults to its 'name'.", - "length": 255, - "name": "displaytext", - "required": false, + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", - "type": "integer" - }, + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" + } + ] + }, + { + "description": "Creates a vm group", + "isasync": false, + "name": "createInstanceGroup", + "params": [ { - "description": "the ID of the VPC offering", + "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { - "description": "create VPC for the project", + "description": "The project of the instance group", "length": 255, "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.", + "description": "the domain ID of account owning the instance group", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. True by default.", - "length": 255, - "name": "start", - "required": false, - "since": "4.3", - "type": "boolean" - }, - { - "description": "the second IPv4 DNS for the VPC", - "length": 255, - "name": "dns2", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", - "length": 255, - "name": "cidr", - "required": true, - "type": "string" - }, - { - "description": "the name of the VPC", + "description": "the name of the instance group", "length": 255, "name": "name", "required": true, "type": "string" } ], - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "related": "updateInstanceGroup", "response": [ { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the name of the instance group", + "name": "name", + "type": "string" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the ID of the instance group", + "name": "id", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "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 service provider name", - "name": "provider", - "response": [ - { - "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": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the domain ID of the instance group", + "name": "domainid", + "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "the project ID of the instance group", + "name": "projectid", + "type": "string" }, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, - {}, { - "description": "the project id of the VPC", - "name": "projectid", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", + "type": "string" + } + ] + }, + { + "description": "Creates an internal load balancer", + "isasync": true, + "name": "createLoadBalancer", + "params": [ + { + "description": "the source IP address the network traffic will be load balanced from", + "length": 255, + "name": "sourceipaddress", + "required": false, "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", + "length": 255, + "name": "instanceport", + "required": true, + "type": "integer" + }, + { + "description": "name of the load balancer", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the load balancer scheme. Supported value in this release is Internal", + "length": 255, + "name": "scheme", + "required": true, "type": "string" }, { - "description": "the owner of the VPC", - "name": "account", + "description": "the description of the load balancer", + "length": 4096, + "name": "description", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", + "required": true, "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "The guest network the load balancer will be created for", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": true, + "type": "uuid" }, { - "description": "zone id of the vpc", - "name": "zoneid", - "type": "string" + "description": "the network id of the source ip address", + "length": 255, + "name": "sourceipaddressnetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": true, + "type": "uuid" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the source port the network traffic will be load balanced from", + "length": 255, + "name": "sourceport", + "required": true, + "type": "integer" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" - }, + } + ], + "related": "", + "response": [ { - "description": "the project name of the VPC", - "name": "project", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "Load Balancer source ip", + "name": "sourceipaddress", "type": "string" }, - {}, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the project name of the Load Balancer", + "name": "project", + "type": "string" }, { - "description": "the list of resource tags associated with the project", - "name": "tags", + "description": "the list of instances associated with the Load Balancer", + "name": "loadbalancerinstance", "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": "resource type", - "name": "resourcetype", + "description": "the instance ID", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the state of the instance", + "name": "state", "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": "the name of the instance", + "name": "name", "type": "string" } ], "type": "list" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the description of the Load Balancer", + "name": "description", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "Load Balancer network id", + "name": "networkid", "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the list of rules associated with the Load Balancer", + "name": "loadbalancerrule", + "response": [ + { + "description": "instance port of the load balancer rule", + "name": "instanceport", + "type": "integer" + }, + { + "description": "the state of the load balancer rule", + "name": "state", + "type": "string" + }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + } + ], + "type": "list" + }, + { + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the name of the Load Balancer", + "name": "name", + "type": "string" }, + {}, { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", + "description": "the domain ID of the Load Balancer", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the domain to which the Load Balancer belongs", + "name": "domainpath", "type": "string" }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the Load Balancer", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Deletes a autoscale policy.", + "description": "Adds a Palo Alto firewall device", "isasync": true, - "name": "deleteAutoScalePolicy", + "name": "addPaloAltoFirewall", "params": [ { - "description": "the ID of the autoscale policy", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "password", "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "supports only PaloAltoFirewall", + "length": 255, + "name": "networkdevicetype", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Credentials to reach Palo Alto firewall device", + "length": 255, + "name": "username", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "URL of the Palo Alto appliance.", + "length": 255, + "name": "url", + "required": true, + "type": "string" }, - {}, - {} - ] - }, - { - "description": "Deletes a role", - "isasync": false, - "name": "deleteRole", - "params": [ { - "description": "ID of the role", + "description": "the Physical Network ID", "length": 255, - "name": "id", - "related": "createRole,importRole,listRoles,updateRole", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": true, "type": "uuid" } ], + "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { @@ -73183,275 +69355,260 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ], - "since": "4.9.0" - }, - { - "description": " delete a Cisco Nexus VSM device", - "isasync": true, - "name": "deleteCiscoNexusVSM", - "params": [ + "description": "the usage interface of the external firewall", + "name": "usageinterface", + "type": "string" + }, { - "description": "Id of the Cisco Nexus 1000v VSM device to be deleted", - "length": 255, - "name": "id", - "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" + }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the private interface of the external firewall", + "name": "privateinterface", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, - {} - ] - }, - { - "description": "List internal LB VMs.", - "isasync": false, - "name": "listInternalLoadBalancerVMs", - "params": [ { - "description": "if true is passed for this parameter, list only VPC Internal LB VMs", - "length": 255, - "name": "forvpc", - "required": false, - "type": "boolean" + "description": "device state", + "name": "fwdevicestate", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the public security zone of the external firewall", + "name": "publiczone", + "type": "string" }, { - "description": "List Internal LB VMs by VPC", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" + "description": "the private security zone of the external firewall", + "name": "privatezone", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", + "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": "name of the provider", + "name": "provider", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" }, { - "description": "the name of the Internal LB VM", + "description": "device name", + "name": "fwdevicename", + "type": "string" + } + ] + }, + { + "description": "Creates a private gateway", + "isasync": true, + "name": "createPrivateGateway", + "params": [ + { + "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": "name", + "name": "sourcenatsupported", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the state of the Internal LB VM", + "description": "the IP address of the Private gateaway", "length": 255, - "name": "state", - "required": false, + "name": "ipaddress", + "required": true, "type": "string" }, { - "description": "the ID of the Internal LB VM", + "description": "the VPC network belongs to", "length": 255, - "name": "id", - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": true, "type": "uuid" }, { - "description": "the Pod ID of the Internal LB VM", + "description": "the ID of the network ACL", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, "type": "uuid" }, { - "description": "list by network id", + "description": "the uuid of the network offering to use for the private gateways network connection", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, "type": "uuid" }, { - "description": "", + "description": "when true bypasses VLAN id/range overlap check during private gateway creation", "length": 255, - "name": "page", + "name": "bypassvlanoverlapcheck", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", + "description": "the network implementation uri for the private gateway", "length": 255, - "name": "fetchhealthcheckresults", + "name": "vlan", "required": false, - "since": "4.14", - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "the netmask of the Private gateway", "length": 255, - "name": "keyword", - "required": false, + "name": "netmask", + "required": true, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The isolated network this private gateway is associated to.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, + "since": "4.17.0", "type": "uuid" }, { - "description": "the host ID of the Internal LB VM", + "description": "the Physical Network ID the network belongs to", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the gateway of the Private gateway", "length": 255, - "name": "account", - "required": false, + "name": "gateway", + "required": true, "type": "string" - }, - { - "description": "the Zone ID of the Internal LB VM", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" } ], - "related": "destroyRouter,listRouters", + "related": "createPrivateGateway,listPrivateGateways", "response": [ { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the gateway", + "name": "gateway", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the account associated with the private gateway", + "name": "account", + "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, + {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the project name of the private gateway", + "name": "project", "type": "string" }, + {}, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "path of the domain to which the private gateway belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { @@ -73460,795 +69617,559 @@ "type": "integer" }, { - "description": "role of the domain router", - "name": "role", + "description": "the ID of the domain associated with the private gateway", + "name": "domainid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "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 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 project id of the private gateway", + "name": "projectid", + "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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 ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - } - ], - "type": "set" + "description": "ACL name set for private gateway", + "name": "aclname", + "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "Source Nat enable status", + "name": "sourcenatsupported", "type": "boolean" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "VPC name the private gateway belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "zone id of the private gateway", + "name": "zoneid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the private gateway's netmask", + "name": "netmask", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" - }, + } + ], + "since": "4.17.0" + }, + { + "description": "Deletes a firewall rule", + "isasync": true, + "name": "deleteFirewallRule", + "params": [ { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, + "description": "the ID of the firewall rule", + "length": 255, + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "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 Pod ID for the router", - "name": "podid", + "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": "Upload a certificate to CloudStack", + "isasync": false, + "name": "uploadSslCert", + "params": [ { - "description": "the name of the router", - "name": "name", + "description": "Private key", + "length": 16384, + "name": "privatekey", + "required": true, "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "account that will own the SSL certificate", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "type": "string" + "description": "Enables revocation checking for certificates", + "length": 255, + "name": "enabledrevocationcheck", + "required": false, + "since": "4.15", + "type": "boolean" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "Certificate chain of trust", + "length": 2097152, + "name": "certchain", + "required": false, "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "Password for the private key", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" + "description": "an optional project for the SSL certificate", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "Name for the uploaded certificate", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "SSL certificate", + "length": 16384, + "name": "certificate", + "required": true, "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, + "description": "domain ID of the account owning the SSL certificate", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the second DNS for the router", - "name": "dns2", + "description": "certificate chain", + "name": "certchain", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "SSL certificate ID", + "name": "id", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "name", + "name": "name", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" }, - {}, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "account for the certificate", + "name": "account", "type": "string" }, + {}, { - "description": "the domain associated with the router", + "description": "the domain name of the network owner", "name": "domain", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", + "description": "certificate", + "name": "certificate", "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - {} + } ] }, { - "description": "Lists Cisco VNMC controllers", + "description": "Updates the registered OAuth provider details", "isasync": false, - "name": "listCiscoVnmcResources", + "name": "updateOauthProvider", "params": [ { - "description": "", + "description": "Description of the OAuth Provider", "length": 255, - "name": "page", + "name": "description", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Cisco VNMC resource ID", + "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, - "name": "resourceid", - "related": "listCiscoVnmcResources", + "name": "clientid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "Redirect URI pre-registered in the specific OAuth provider", "length": 255, - "name": "pagesize", + "name": "redirecturi", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "id of the OAuth provider to be updated", "length": 255, - "name": "keyword", + "name": "id", + "related": "updateOauthProvider", + "required": true, + "type": "uuid" + }, + { + "description": "Secret Key pre-registered in the specific OAuth provider", + "length": 255, + "name": "secretkey", "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "OAuth provider will be enabled or disabled based on this value", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "enabled", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "", "response": [ - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Description of the provider registered", + "name": "description", + "type": "string" }, - {}, - {}, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, - {} - ] - }, - { - "description": "Removes detail for the Resource.", - "isasync": true, - "name": "removeResourceDetail", - "params": [ + {}, { - "description": "Delete details for resource id", - "length": 255, - "name": "resourceid", - "required": true, + "description": "Name of the provider", + "name": "name", "type": "string" }, { - "description": "Delete details matching key/value pairs", - "length": 255, - "name": "key", - "required": false, + "description": "ID of the provider", + "name": "id", "type": "string" }, { - "description": "Delete detail by resource type", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" - } - ], - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", + "type": "string" + }, + { + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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" + } + ], + "since": "4.19.0" }, { - "description": "Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail.", + "description": "Creates site to site vpn customer gateway", "isasync": true, - "name": "executeClusterDrsPlan", + "name": "createVpnCustomerGateway", "params": [ { - "description": "ID of cluster", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", + "name": "ipsecpsk", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", + "description": "Force Encapsulation for NAT traversal", "length": 255, - "name": "migrateto", + "name": "forceencap", "required": false, - "type": "map" - } - ], - "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": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "type": "boolean" }, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "description": "create site-to-site VPN customer gateway for the project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "since": "4.6", + "type": "uuid" }, { - "description": "unique ID of the drs plan for cluster", - "name": "id", + "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": "Start event Id of the DRS Plan", - "name": "eventid", + "description": "IKE policy of the customer gateway", + "length": 255, + "name": "ikepolicy", + "required": true, "type": "string" }, { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "Id of the cluster", - "name": "clusterid", - "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Lists all supported OS types for this cloud.", - "isasync": false, - "name": "listOsTypes", - "params": [ - { - "description": "list by Os type Id", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs", + "name": "ikelifetime", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "list os by description", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "description", + "name": "dpd", "required": false, - "since": "3.0.1", + "type": "boolean" + }, + { + "description": "ESP policy of the customer gateway", + "length": 255, + "name": "esppolicy", + "required": true, "type": "string" }, { - "description": "", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "page", + "name": "esplifetime", "required": false, - "type": "integer" + "type": "long" }, { - "description": "list by Os Category id", + "description": "name of this customer gateway", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "public ip address id of the customer gateway", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "gateway", + "required": true, + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", "length": 255, - "name": "fordisplay", + "name": "ikeversion", "required": false, - "since": "4.18.1", - "type": "boolean" + "since": "4.15.1", + "type": "string" }, { - "description": "List by keyword", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "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": "addGuestOs", + "related": "updateVpnCustomerGateway", "response": [ { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" + "description": "the vpn gateway ID", + "name": "id", + "type": "string" }, { - "description": "the name/description of the OS type", - "name": "description", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the ID of the OS type", - "name": "id", + "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": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the name of the OS type", - "name": "name", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" }, { - "description": "the name of the OS category", - "name": "oscategoryname", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "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", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, - {}, - { - "description": "is the guest OS user defined", - "name": "isuserdefined", - "type": "boolean" - } - ] - }, - { - "description": "Deletes a particular egress rule from this security group", - "isasync": true, - "name": "revokeSecurityGroupEgress", - "params": [ - { - "description": "The ID of the egress rule", - "length": 255, - "name": "id", - "related": "authorizeSecurityGroupIngress", - "required": true, - "type": "uuid" - } - ], - "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" - } - ], - "since": "3.0.0" - }, - { - "description": "Removes a Guest OS from listing.", - "isasync": true, - "name": "removeGuestOs", - "params": [ - { - "description": "ID of the guest OS", - "length": 255, - "name": "id", - "related": "addGuestOs", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of the customer gateway", + "name": "name", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the owner", + "name": "account", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" - } - ], - "since": "4.4.0" - }, - { - "description": "Uploads an icon for the specified resource(s)", - "isasync": false, - "name": "uploadResourceIcon", - "params": [ - { - "description": "list of resources to upload the icon/image for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" }, { - "description": "Base64 string representation of the resource icon/image", - "length": 2097152, - "name": "base64image", - "required": true, + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, + "description": "the project name", + "name": "project", "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", @@ -74256,1311 +70177,629 @@ "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" }, {} - ], - "since": "4.16.0.0" + ] }, { - "description": "Update a supported Kubernetes version", + "description": "remove an annotation.", "isasync": false, - "name": "updateKubernetesSupportedVersion", + "name": "removeAnnotation", "params": [ { - "description": "the enabled or disabled state of the Kubernetes supported version", - "length": 255, - "name": "state", - "required": true, - "type": "string" - }, - { - "description": "the ID of the Kubernetes supported version", + "description": "the id of the annotation", "length": 255, "name": "id", - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "listKubernetesSupportedVersions", + "related": "addAnnotation,listAnnotations", "response": [ { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the (uu)id of the annotation", + "name": "id", + "type": "string" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, - {}, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", - "type": "integer" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "type": "string" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", - "type": "string" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, + {}, { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.11" + }, + { + "description": "add a baremetal host", + "isasync": false, + "name": "addBaremetalHost", + "params": [ + { + "description": "ip address intentionally allocated to this host after provisioning", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "list of tags to be added to the host", + "length": 255, + "name": "hosttags", + "required": false, + "type": "list" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the cluster ID for the host", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cluster name for the host", + "length": 255, + "name": "clustername", + "required": false, "type": "string" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", + "description": "the host URL", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" - } - ] - }, - { - "description": "Detaches any ISO file (if any) currently attached to a virtual machine.", - "isasync": true, - "name": "detachIso", - "params": [ + "description": "the Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { - "description": "If true, ejects the ISO before detaching on VMware. Default: false", + "description": "hypervisor type of the host", "length": 255, - "name": "forced", - "required": false, - "since": "4.15.1", - "type": "boolean" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "The ID of the virtual machine", + "description": "the Pod ID for the host", "length": 255, - "name": "virtualmachineid", - "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,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", "required": true, "type": "uuid" + }, + { + "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "length": 255, + "name": "password", + "required": false, + "type": "string" + }, + { + "description": "Allocation state of this Host for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, + "type": "string" } ], - "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,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" + }, + { + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "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 list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the 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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "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" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the 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 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 name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the 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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - } - ], - "type": "set" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "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 backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "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": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - {}, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the gateway of the nic", - "name": "gateway", - "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "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", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "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", - "name": "ip6address", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - } - ], - "type": "set" - }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "GPU cards present in the host", + "name": "gpugroup", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", + "description": "GPU cards present in the host", + "name": "gpugroupname", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "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 vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + } + ], "type": "list" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" } ], - "type": "set" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "type": "list" }, { - "description": "the group name of the virtual machine", - "name": "group", - "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 id of userdata used for the VM", - "name": "userdataid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the date when this virtual machine was created", + "description": "the date and time the host was created", "name": "created", "type": "date" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "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 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": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" - } - ] - }, - { - "description": "Creates a guest network IPv6 prefix.", - "isasync": true, - "name": "createGuestNetworkIpv6Prefix", - "params": [ - { - "description": "UUID of zone to which the IPv6 prefix belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "The /56 or higher IPv6 CIDR for network prefix.", - "length": 255, - "name": "prefix", - "required": true, - "type": "string" - } - ], - "related": "listGuestNetworkIpv6Prefixes", - "response": [ - { - "description": "id of the guest IPv6 prefix", - "name": "id", - "type": "string" }, { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "type": "integer" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" - }, - {}, - { - "description": "guest IPv6 prefix", - "name": "prefix", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, - { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" - }, {} - ], - "since": "4.17.0.0" + ] }, { - "description": " delete a Palo Alto firewall device", - "isasync": true, - "name": "deletePaloAltoFirewall", + "description": "Disables a role", + "isasync": false, + "name": "disableRole", "params": [ { - "description": "Palo Alto firewall device ID", + "description": "ID of the role", "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", + "name": "id", + "related": "createRole,listRoles,updateRole", "required": true, "type": "uuid" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {}, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.20.0" }, { - "description": "Deletes a Pod.", + "description": "Deletes a role permission", "isasync": false, - "name": "deletePod", + "name": "deleteRolePermission", "params": [ { - "description": "the ID of the Pod", + "description": "ID of the role permission", "length": 255, "name": "id", - "related": "updatePod,createManagementNetworkIpRange", + "related": "", "required": true, "type": "uuid" } @@ -75571,13 +70810,13 @@ "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", @@ -75588,132 +70827,162 @@ "name": "jobid", "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "Lists Tungsten-Fabric providers", + "description": "Update VM Schedule.", "isasync": false, - "name": "listTungstenFabricProviders", + "name": "updateVMSchedule", "params": [ { - "description": "List by keyword", + "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "keyword", + "name": "startdate", + "required": false, + "type": "date" + }, + { + "description": "Name of the schedule", + "length": 255, + "name": "description", "required": false, "type": "string" }, { - "description": "", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "pagesize", + "name": "timezone", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "Enable VM schedule", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "enabled", + "required": false, + "type": "boolean" + }, + { + "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", + "length": 255, + "name": "schedule", "required": false, + "type": "string" + }, + { + "description": "ID of VM schedule", + "length": 255, + "name": "id", + "related": "updateVMSchedule", + "required": true, "type": "uuid" }, { - "description": "", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "page", + "name": "enddate", "required": false, - "type": "integer" + "type": "date" } ], "related": "", "response": [ + {}, { - "description": "Tungsten-Fabric provider hostname", - "name": "tungstenproviderhostname", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description of VM schedule", + "name": "description", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "Date when the schedule was created", + "name": "created", + "type": "date" }, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", + "description": "ID of virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", + "description": "the ID of VM schedule", + "name": "id", "type": "string" }, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider name", - "name": "name", - "type": "string" + "description": "Action", + "name": "action", + "type": "action" }, - {}, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" }, { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", - "type": "string" + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" } - ] + ], + "since": "4.19.0" }, { - "description": "Lists all DeploymentPlanners available.", + "description": "Lists all configuration groups (primarily used for UI).", "isasync": false, - "name": "listDeploymentPlanners", + "name": "listConfigurationGroups", "params": [ { - "description": "List by keyword", + "description": "lists configuration group by group name", "length": 255, - "name": "keyword", + "name": "group", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } @@ -75721,1850 +70990,968 @@ "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": "Deployment Planner name", + "description": "the precedence of the configuration group", + "name": "precedence", + "type": "long" + }, + { + "description": "the name of the configuration group", "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the configuration group", + "name": "description", "type": "string" }, - {} - ] + {}, + { + "description": "the subgroups of the configuration group", + "name": "subgroup", + "response": [ + { + "description": "the precedence of the configuration subgroup", + "name": "precedence", + "type": "long" + }, + { + "description": "the name of the configuration subgroup", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.18.0" }, { - "description": "Creates a role", + "description": "Releases a Pod IP back to the Pod", "isasync": false, - "name": "createRole", + "name": "releasePodIpAddress", "params": [ { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "UUID of the Pod IP", "length": 255, - "name": "type", - "required": false, + "name": "id", + "required": true, + "type": "long" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "The description of the role", - "length": 255, - "name": "description", - "required": false, + "description": "the current status 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": "Creates a role with this unique name", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Updates remote access vpn", + "isasync": true, + "name": "updateRemoteAccessVpn", + "params": [ + { + "description": "id of the remote access vpn", "length": 255, - "name": "name", + "name": "id", + "related": "createRemoteAccessVpn,listRemoteAccessVpns,updateRemoteAccessVpn", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "ID of the role to be cloned from. Either roleid or type must be passed in", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "ispublic", + "name": "customid", "required": false, - "type": "boolean" + "since": "4.4", + "type": "string" } ], - "related": "importRole,listRoles,updateRole", + "related": "createRemoteAccessVpn,listRemoteAccessVpns", "response": [ + {}, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" }, - {}, { - "description": "the type of the role", - "name": "type", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "true if role is default, false otherwise", - "name": "isdefault", + "description": "the public ip address of the vpn server", + "name": "publicipid", + "type": "string" + }, + { + "description": "is vpn for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the name of the role", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the role", + "description": "the id of the remote access vpn", "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ipsec preshared key", + "name": "presharedkey", + "type": "string" }, - {} - ], - "since": "4.9.0" - }, - { - "description": "Deletes a cluster.", - "isasync": false, - "name": "deleteCluster", - "params": [ + {}, { - "description": "the cluster ID", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the project id of the vpn", + "name": "projectid", + "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", "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the public ip address of the vpn server", + "name": "publicip", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the rule", + "name": "state", "type": "string" } - ] + ], + "since": "4.4" }, { - "description": "Prepares a host for maintenance.", + "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", "isasync": true, - "name": "prepareHostForMaintenance", + "name": "destroyVirtualMachine", "params": [ { - "description": "the host ID", + "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "assignVirtualMachine,deployVirtualMachine,destroyVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": true, "type": "uuid" + }, + { + "description": "Comma separated list of UUIDs for volumes that will be deleted", + "length": 255, + "name": "volumeids", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "since": "4.12.0", + "type": "list" + }, + { + "description": "If true is passed, the vm is expunged immediately. False by default.", + "length": 255, + "name": "expunge", + "required": false, + "since": "4.2.1", + "type": "boolean" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "response": [ { - "description": "the Zone name of the host", - "name": "zonename", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "the name of the host", - "name": "name", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" - }, - { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - {}, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the 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 host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "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 hypervisor version", - "name": "hypervisorversion", - "type": "string" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "GPU cards present in the host", - "name": "gpugroupname", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - } - ], + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "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 project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" } ], - "type": "list" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "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" + "type": "set" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "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 backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, + {}, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, + {}, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the pool type of the virtual machine", + "name": "pooltype", "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" - } - ] - }, - { - "description": "Removes specified region", - "isasync": false, - "name": "removeRegion", - "params": [ - { - "description": "ID of the region to delete", - "length": 255, - "name": "id", - "required": true, - "type": "integer" - } - ], - "response": [ - {}, + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "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 operation is executed successfully", - "name": "success", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Get Volume's iSCSI Name", - "isasync": false, - "name": "getVolumeiScsiName", - "params": [ - { - "description": "CloudStack Volume UUID", - "length": 255, - "name": "volumeid", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - {}, - { - "description": "Volume iSCSI Name", - "name": "volumeiScsiName", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Upload a data disk to the cloudstack cloud.", - "isasync": false, - "name": "getUploadParamsForVolume", - "params": [ { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, + "description": "the group name of the virtual machine", + "name": "group", "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", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "Upload volume/template/iso for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", - "length": 255, + "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "Image store uuid", - "length": 255, - "name": "imagestoreuuid", - "required": false, "type": "string" }, { - "description": "the name of the volume/template/iso", - "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "related": "getUploadParamsForTemplate,getUploadParamsForIso", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" - }, - { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" - }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" - } - ], - "since": "4.6.0" - }, - { - "description": "Updates an existing autoscale vm group.", - "isasync": true, - "name": "updateAutoScaleVmGroup", - "params": [ - { - "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 in which the performance counters to be collected", - "length": 255, - "name": "interval", - "required": false, - "type": "integer" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "length": 255, - "name": "maxmembers", - "required": false, - "type": "integer" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the autoscale vmgroup", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "length": 255, - "name": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": false, - "type": "list" - }, - { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "length": 255, - "name": "minmembers", - "required": false, + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "list of scaledown autoscale policies", - "length": 255, - "name": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": false, - "type": "list" - }, - { - "description": "the ID of the autoscale group", - "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, - "type": "uuid" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" - } - ], - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", - "response": [ + }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "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 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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" - }, - { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, - {}, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the project name of the vm group", - "name": "project", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the private port", - "name": "privateport", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, - {}, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "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 list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the 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": "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the public ip address", - "name": "publicip", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - } - ] - }, - { - "description": "Updates an existing autoscale vm profile.", - "isasync": true, - "name": "updateAutoScaleVmProfile", - "params": [ - { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "length": 255, - "name": "expungevmgraceperiod", - "required": false, + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", - "required": false, - "since": "4.18.0", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "length": 255, - "name": "autoscaleuserid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "an optional field, whether to the display the profile to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "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 autoscale vm profile", - "length": 255, - "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "required": true, - "type": "uuid" - }, - { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18.1", - "type": "map" - }, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", - "length": 255, - "name": "otherdeployparams", - "required": false, - "since": "4.18.0", - "type": "map" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the ID of the userdata", - "length": 255, - "name": "userdataid", - "related": "", - "required": false, - "since": "4.18.1", - "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 template of the auto deployed virtual machine", - "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "uuid" - }, - { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", - "length": 255, - "name": "counterparam", - "required": false, - "type": "map" - }, - { - "description": "the service offering of the auto deployed virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.18.0", - "type": "uuid" - } - ], - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", - "response": [ - { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - }, - { - "description": "the autoscale vm profile ID", - "name": "id", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", - "type": "string" - }, - { - "description": "the project id vm profile", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "Base 64 encoded VM user data", - "name": "userdata", - "type": "string" - }, - {}, - { - "description": "is profile 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 id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", - "type": "string" - }, - {}, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain name of the vm profile", - "name": "domain", - "type": "string" - }, - { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the account owning the instance group", - "name": "account", - "type": "string" - } - ] - }, - { - "description": "Enables an AutoScale Vm Group", - "isasync": true, - "name": "enableAutoScaleVmGroup", - "params": [ - { - "description": "the ID of the autoscale group", - "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", - "required": true, - "type": "uuid" - } - ], - "related": "listAutoScaleVmGroups", - "response": [ - { - "description": "the project id of the vm group", - "name": "projectid", - "type": "string" - }, - { - "description": "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.", - "name": "minmembers", - "type": "int" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", - "name": "maxmembers", - "type": "int" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" - }, - { - "description": "the domain ID of the vm group", - "name": "domainid", - "type": "string" - }, - { - "description": "is group for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" - }, - { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "the project name of the vm group", - "name": "project", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" - }, - { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" - }, - { - "description": "the domain name of the vm group", - "name": "domain", - "type": "string" - }, - { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" - }, - { - "description": "the account owning the vm group", - "name": "account", - "type": "string" - }, - { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the name of the autoscale vm group ", - "name": "name", - "type": "string" - }, - { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", - "type": "string" - }, - { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Deletes a snapshot of a disk volume.", - "isasync": true, - "name": "deleteSnapshot", - "params": [ - { - "description": "The ID of the zone for the snapshot", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.19.0", - "type": "uuid" - }, - { - "description": "The ID of the snapshot", - "length": 255, - "name": "id", - "related": "copySnapshot,revertSnapshot,listSnapshots", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} - ] - }, - { - "description": "Lists guest network IPv6 prefixes", - "isasync": false, - "name": "listGuestNetworkIpv6Prefixes", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "UUID of zone to which the IPv6 prefix belongs to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "UUID of the IPv6 prefix.", - "length": 255, - "name": "id", - "related": "listGuestNetworkIpv6Prefixes", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", - "type": "integer" - }, - { - "description": "guest IPv6 prefix", - "name": "prefix", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", - "type": "integer" - }, - { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" - }, - { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "id of the guest IPv6 prefix", - "name": "id", - "type": "string" - }, - { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" - }, - {} - ], - "since": "4.17.0" - }, - { - "description": "List the virtual machines owned by the account.", - "isasync": false, - "name": "listVirtualMachines", - "params": [ - { - "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", - "length": 255, - "name": "isvnf", - "required": false, - "since": "4.19.0", - "type": "boolean" - }, - { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "list 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 the service offering", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.4", - "type": "uuid" - }, - { - "description": "list vms by ssh keypair name", - "length": 255, - "name": "keypair", - "required": false, - "type": "string" - }, - { - "description": "flag to display the resource icon for VMs", - "length": 255, - "name": "showicon", - "required": false, - "since": "4.16.0.0", - "type": "boolean" - }, - { - "description": "", - "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": "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": "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 vms by iso", - "length": 255, - "name": "isoid", - "required": false, - "type": "uuid" - }, - { - "description": "the IDs of the virtual machines, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "since": "4.4", - "type": "list" - }, - { - "description": "the availability zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", - "length": 255, - "name": "accumulate", - "required": false, - "since": "4.17.0", - "type": "boolean" - }, - { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", - "length": 255, - "name": "haenable", - "required": false, - "since": "4.15", - "type": "boolean" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "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": "list by the backup offering", - "length": 255, - "name": "backupofferingid", - "required": false, - "since": "4.17", - "type": "uuid" - }, - { - "description": "list vms by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the group ID", - "length": 255, - "name": "groupid", - "related": "createInstanceGroup", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of AutoScaling VM Group", - "length": 255, - "name": "autoscalevmgroupid", - "related": "listAutoScaleVmGroups", - "required": false, - "since": "4.18.0", - "type": "uuid" - }, - { - "description": "list by network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" - }, - { - "description": "the host ID", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "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": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "since": "4.16.0", - "type": "uuid" - }, - { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", - "length": 255, - "name": "userdata", - "required": false, - "since": "4.18.0.0", - "type": "boolean" - }, - { - "description": "the pod ID", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "list vms by template", - "length": 255, - "name": "templateid", - "related": "listIsos,registerIso,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" - }, - { - "description": "list vms by vpc", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "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", - "required": false, - "type": "string" - }, - { - "description": "the security group ID", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", - "required": false, - "since": "4.15", - "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" - } - ], - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - {}, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "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", @@ -77576,85 +71963,115 @@ "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 domain ID of the security group", + "name": "domainid", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "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" } ], "type": "set" }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", "type": "set" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "the CIDR notation for the base IP address of the security group rule", @@ -77662,23 +72079,8 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -77686,98 +72088,113 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "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 protocol of the security group rule", - "name": "protocol", + "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" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -77799,19 +72216,39 @@ "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -77820,8 +72257,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -77833,163 +72270,140 @@ "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the 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 starting IP of the security group rule", + "name": "startport", + "type": "integer" } ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, + } + ] + }, + { + "description": "Starts a virtual machine.", + "isasync": true, + "name": "startVirtualMachine", + "params": [ { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "since": "3.0.1", + "type": "uuid" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "Boot into hardware setup menu or not", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, + "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", + "length": 255, + "name": "considerlasthost", + "required": false, + "since": "4.18.0", + "type": "boolean" + } + ], + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the name of the affinity group", - "name": "name", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { @@ -78002,157 +72416,100 @@ "name": "domain", "type": "string" }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, { "description": "the ID of the affinity group", "name": "id", "type": "string" }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, { "description": "virtual machine IDs associated with this affinity group", "name": "virtualmachineIds", "type": "list" - } - ], - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "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 list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project ID of the affinity group", "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, + {}, { "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", @@ -78164,262 +72521,416 @@ "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project 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 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 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" + } + ], + "type": "set" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the 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": "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the ID of the nic", + "description": "the ID of the security group", "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 IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" } ], "type": "set" }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, { "description": "the name of userdata used for the VM", "name": "userdataname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "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", @@ -78427,8 +72938,8 @@ "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { @@ -78437,73 +72948,70 @@ "type": "long" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "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", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "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 ID of the virtual machine", - "name": "id", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { @@ -78512,783 +73020,643 @@ "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - } - ] - }, - { - "description": "Updates the information about Guest OS to Hypervisor specific name mapping", - "isasync": true, - "name": "updateGuestOsMapping", - "params": [ - { - "description": "UUID of the Guest OS to hypervisor name Mapping", - "length": 255, - "name": "id", - "related": "updateGuestOsMapping", - "required": true, - "type": "uuid" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", - "length": 255, - "name": "osmappingcheckenabled", - "required": false, - "since": "4.19.0", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "Hypervisor specific name for this Guest OS", - "length": 255, - "name": "osnameforhypervisor", - "required": true, + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the hypervisor", - "name": "hypervisor", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, - {} - ], - "since": "4.4.0" - }, - { - "description": "delete Tungsten-Fabric tag", - "isasync": true, - "name": "deleteTungstenFabricTag", - "params": [ { - "description": "the uuid of Tungsten-Fabric tag", - "length": 255, - "name": "taguuid", - "required": true, + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - {}, + "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": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Lists all available disk offerings.", - "isasync": false, - "name": "listDiskOfferings", - "params": [ - { - "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": "name of the disk offering", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, + "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.17", - "type": "uuid" - }, - { - "description": "listed offerings support disk encryption", - "length": 255, - "name": "encrypt", - "required": false, - "since": "4.18", - "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 volume, tags of the volume are used to filter the offerings", - "length": 255, - "name": "volumeid", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "since": "4.17", - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "ID of the disk offering", - "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "the storage type of the service offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, - "since": "4.19", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the 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": "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 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 IPv6 address of network", + "name": "ip6address", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the 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 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" + } + ], + "type": "set" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - } - ], - "related": "createDiskOffering", - "response": [ - { - "description": "unique ID of the disk offering", - "name": "id", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "State of the Service from LB rule", + "name": "servicestate", "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": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" - }, - { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "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": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - {}, - { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" - }, - { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" - }, - { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "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 optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" - }, - { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" - }, - { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" - }, - {}, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "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": "Update password of a host/pool on management server.", + "description": "Lists the resource icon for the specified resource(s)", "isasync": false, - "name": "updateHostPassword", + "name": "listResourceIcon", "params": [ { - "description": "the new password for the host/cluster", + "description": "type of the resource", "length": 255, - "name": "password", + "name": "resourcetype", "required": true, "type": "string" }, { - "description": "the cluster ID", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, + "name": "resourceids", + "required": true, + "type": "list" + } + ], + "related": "", + "response": [ + {}, { - "description": "if the password should also be updated on the hosts", - "length": 255, - "name": "update_passwd_on_host", - "required": false, - "type": "boolean" + "description": "resource type", + "name": "resourcetype", + "type": "resourceobjecttype" }, { - "description": "the username for the host/cluster", - "length": 255, - "name": "username", - "required": true, + "description": "base64 representation of resource icon", + "name": "base64image", "type": "string" }, - { - "description": "the host ID", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" - } - ], - "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "id of the resource", + "name": "resourceid", "type": "string" - }, - {} - ] + } + ], + "since": "4.16.0.0" }, { - "description": "adds a range of portable public IP's to a region", - "isasync": true, - "name": "createPortableIpRange", + "description": "Creates a new Pod.", + "isasync": false, + "name": "createPod", "params": [ { - "description": "the beginning IP address in the portable IP range", + "description": "the netmask for the Pod", "length": 255, - "name": "startip", - "required": true, + "name": "netmask", + "required": false, "type": "string" }, { - "description": "the netmask of the portable IP range", + "description": "the starting IP address for the Pod", "length": 255, - "name": "netmask", - "required": true, + "name": "startip", + "required": false, "type": "string" }, { - "description": "Id of the Region", + "description": "the Zone ID in which the Pod will be created", "length": 255, - "name": "regionid", - "related": "addRegion,listRegions", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "VLAN id, if not specified defaulted to untagged", + "description": "Allocation state of this Pod for allocation of new resources", "length": 255, - "name": "vlan", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the ending IP address in the portable IP range", + "description": "the name of the Pod", "length": 255, - "name": "endip", + "name": "name", "required": true, "type": "string" }, { - "description": "the gateway for the portable IP range", + "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": true, + "required": false, "type": "string" } ], - "related": "", + "related": "listPods,createManagementNetworkIpRange", "response": [ { - "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", - "name": "portableipaddress", + "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 IP ranges for the Pod", + "name": "ipranges", "response": [ { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "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": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the account ID the portable IP address is associated with", - "name": "accountid", + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" } ], "type": "list" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "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 end ip of the portable IP range", - "name": "endip", - "type": "string" - }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the name of the Pod", + "name": "name", "type": "string" }, { - "description": "the netmask of the VLAN IP range", + "description": "the netmask of the Pod", "name": "netmask", "type": "string" }, { - "description": "the start ip of the portable IP range", - "name": "startip", - "type": "string" - }, - {}, - { - "description": "portable IP range ID", - "name": "id", - "type": "string" - }, - { - "description": "Region Id in which portable ip range is provisioned", - "name": "regionid", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {} - ], - "since": "4.2.0" - }, - { - "description": "Updates an existing cluster", - "isasync": false, - "name": "updateCluster", - "params": [ - { - "description": "the ID of the Cluster", - "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" - }, - { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" - }, - { - "description": "hypervisor type of the cluster", - "length": 255, - "name": "clustertype", - "required": false, - "type": "string" - }, - { - "description": "Allocation state of this cluster for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, - "type": "string" - }, - { - "description": "whether this cluster is managed by cloudstack", - "length": 255, - "name": "managedstate", - "required": false, - "type": "string" - }, - { - "description": "the cluster name", - "length": 255, - "name": "clustername", - "required": false, - "type": "string" - } - ], - "related": "addCluster", - "response": [ - {}, - { - "description": "the Zone name of the cluster", + "description": "the Zone name of the Pod", "name": "zonename", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "type": "string" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", - "type": "string" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "string" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the ID of the Pod", + "name": "id", "type": "string" }, { @@ -79297,38 +73665,32 @@ "type": "integer" }, { - "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 cluster name", - "name": "name", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "the cluster ID", - "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 Pod name of the cluster", - "name": "podname", - "type": "string" + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" }, { - "description": "the capacity of the Cluster", + "description": "the capacity of the Pod", "name": "capacity", "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", "type": "string" }, { @@ -79342,9 +73704,14 @@ "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" }, { "description": "the capacity type", @@ -79352,8 +73719,8 @@ "type": "short" }, { - "description": "the capacity name", - "name": "name", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { @@ -79361,671 +73728,306 @@ "name": "zoneid", "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 total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" } ], "type": "list" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "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 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": "Lists the VMs in a VMware Datacenter", + "description": "Safely removes raw records from cloud_usage table", "isasync": false, - "name": "listVmwareDcVms", + "name": "removeRawUsageRecords", "params": [ { - "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "Specify the number of days (greater than zero) to remove records that are older than those number of days from today. For example, specifying 10 would result in removing all the records created before 10 days from today", "length": 255, - "name": "vcenter", - "required": false, - "type": "string" - }, + "name": "interval", + "required": true, + "type": "integer" + } + ], + "response": [ { - "description": "UUID of a linked existing vCenter", - "length": 255, - "name": "existingvcenterid", - "related": "addVmwareDc,listVmwareDcs", - "required": false, - "type": "uuid" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, + {}, { - "description": "The password for specified username.", - "length": 255, - "name": "password", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Name of VMware datacenter.", - "length": 255, - "name": "datacentername", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ], + "since": "4.6.0" + }, + { + "description": "Issues and propagates client certificate on a connected host/agent using configured CA plugin", + "isasync": true, + "name": "provisionCertificate", + "params": [ { - "description": "The Username required to connect to resource.", + "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": "username", + "name": "reconnect", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "page", + "name": "provider", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" } ], - "related": "listUnmanagedInstances", "response": [ { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, + {}, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "4.11.0" + }, + { + "description": "Lists VM metrics", + "isasync": false, + "name": "listVirtualMachinesMetrics", + "params": [ { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", - "type": "string" + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" + "description": "the storage ID where vm's volumes belong to", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ - { - "description": "the controller of the disk", - "name": "datastoretype", - "type": "string" - }, - { - "description": "the label of the disk", - "name": "label", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "controller", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorehost", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" - }, - { - "description": "the position of the disk", - "name": "position", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "datastorename", - "type": "string" - }, - { - "description": "the file path of the disk image", - "name": "imagepath", - "type": "string" - }, - { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" - }, - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the ID of the disk", - "name": "id", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ - { - "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the 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 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": "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 ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" - }, - {}, - { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", - "type": "string" + "description": "the ID of the virtual machine", + "length": 255, + "name": "id", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" + "description": "list vms by iso", + "length": 255, + "name": "isoid", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", - "type": "string" - }, - { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" - } - ] - }, - { - "description": "Deletes a Cisco ASA 1000v appliance", - "isasync": false, - "name": "deleteCiscoAsa1000vResource", - "params": [ - { - "description": "Cisco ASA 1000v resource ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "resourceid", - "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", - "required": true, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "length": 255, + "name": "userdata", + "required": false, + "since": "4.18.0.0", "type": "boolean" }, - {} - ] - }, - { - "description": "Upgrades a running CloudManaged Kubernetes cluster", - "isasync": true, - "name": "upgradeKubernetesCluster", - "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "list vms by vpc", "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,upgradeKubernetesCluster", - "required": true, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, "type": "uuid" }, { - "description": "the ID of the Kubernetes version for upgrade", + "description": "list by the service offering", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", - "required": true, - "type": "uuid" - } - ], - "related": "createKubernetesCluster,startKubernetesCluster", - "response": [ - { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" - }, - { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, - { - "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": "the ID of the service offering of the Kubernetes cluster", "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" - }, - { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" - }, - { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.4", + "type": "uuid" }, - {}, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "the user ID that created the VM and is under the account that owns the VM", + "length": 255, + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", + "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", + "length": 255, + "name": "details", + "required": false, "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "length": 255, + "name": "accumulate", + "required": false, + "since": "4.17.0", "type": "boolean" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", - "type": "string" - }, - { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" - }, - { - "description": "Public IP Address of the cluster", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "type": "string" - }, - { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" - }, - { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" - }, - { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "length": 255, + "name": "haenable", + "required": false, + "since": "4.15", + "type": "boolean" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "description": "the host ID", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "keypair details", + "description": "list vms by ssh keypair name", + "length": 255, "name": "keypair", + "required": false, "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" - }, - { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" - }, - { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" - }, - { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "flag to display the resource icon for VMs", + "length": 255, + "name": "showicon", + "required": false, + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "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": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "List profile in ucs manager", - "isasync": false, - "name": "listUcsProfiles", - "params": [ { "description": "List by keyword", "length": 255, @@ -80034,854 +74036,1104 @@ "type": "string" }, { - "description": "the id for the ucs manager", + "description": "the pod ID", "length": 255, - "name": "ucsmanagerid", - "related": "addUcsManager", - "required": true, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": false, "type": "uuid" }, { - "description": "", + "description": "list vms by affinity group", "length": 255, - "name": "pagesize", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", "length": 255, - "name": "page", + "name": "isvnf", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "since": "4.19.0", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" }, { - "description": "ucs profile dn", - "name": "ucsdn", - "type": "string" - } - ] - }, - { - "description": "Lists storage providers.", - "isasync": false, - "name": "listStorageProviders", - "params": [ - { - "description": "the type of storage provider: either primary or image", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "type", - "required": true, - "type": "string" + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "", + "description": "list by the backup offering", "length": 255, - "name": "pagesize", + "name": "backupofferingid", "required": false, - "type": "integer" + "since": "4.17", + "type": "uuid" }, { - "description": "", + "description": "the group ID", "length": 255, - "name": "page", + "name": "groupid", + "related": "updateInstanceGroup", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the security group ID", "length": 255, - "name": "keyword", + "name": "securitygroupid", + "related": "updateSecurityGroup", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the name of the storage provider", - "name": "name", - "type": "string" + "since": "4.15", + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, - {}, { - "description": "the type of the storage provider: primary or image provider", - "name": "type", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "This command allows the user to query the seceret and API keys for the account", - "isasync": false, - "name": "getUserKeys", - "params": [ { - "description": "ID of the user whose keys are required", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup", + "required": false, + "since": "4.18.0", "type": "uuid" - } - ], - "related": "registerUserKeys", - "response": [ - { - "description": "the secret key of the registered user", - "name": "secretkey", - "type": "string" }, { - "description": "the api key of the registered user", - "name": "apikey", - "type": "string" + "description": "the IDs of the virtual machines, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "since": "4.4", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.10.0" - }, - { - "description": "update global load balancer rules.", - "isasync": true, - "name": "updateGlobalLoadBalancerRule", - "params": [ { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "gslblbmethod", + "name": "forvirtualnetwork", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the global load balancer rule", + "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": "id", - "related": "updateGlobalLoadBalancerRule", - "required": true, - "type": "uuid" + "name": "state", + "required": false, + "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "list vms by template", "length": 255, - "name": "gslbstickysessionmethodname", + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "string" + "type": "uuid" } ], - "related": "", + "related": "listVirtualMachinesMetrics", "response": [ { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, - { - "description": "name of the global load balancer rule", - "name": "name", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the description of the global load balancer rule", - "name": "description", - "type": "string" - }, - { - "description": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", - "type": "string" - }, - {}, - { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", - "type": "string" - }, - { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the total memory capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "network read in MiB", + "name": "networkread", "type": "string" }, - {}, { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "List of load balancer rules that are part of GSLB rule", - "name": "loadbalancerrule", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project name of the load balancer", - "name": "project", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "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 public ip address id", + "description": "public IP address id associated with this nic via Static nat rule", "name": "publicipid", "type": "string" }, { - "description": "the list of resource tags associated with load balancer", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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 value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "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 Secondary ipv4 addr of nic", + "name": "secondaryip", "type": "list" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" - } - ] - }, - { - "description": "Creates a condition for VM auto scaling", - "isasync": true, - "name": "createCondition", - "params": [ + }, { - "description": "Value for which the Counter will be evaluated with the Operator selected.", - "length": 255, - "name": "threshold", - "required": true, - "type": "long" + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" }, { - "description": "ID of the Counter.", - "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", - "required": true, - "type": "uuid" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "an optional project for condition", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the account of the condition. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the domain ID of the account.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", - "length": 255, - "name": "relationaloperator", - "required": true, + "description": "User VM type", + "name": "vmtype", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the id of the Condition", - "name": "id", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the Id of the Counter.", - "name": "counterid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the owner of the Condition.", - "name": "account", + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "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 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 domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the project name of the Condition", - "name": "project", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the Name of the Counter.", - "name": "countername", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, - {}, { - "description": "Threshold Value for the counter.", - "name": "threshold", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the domain name of the owner.", - "name": "domain", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the domain id of the Condition owner", - "name": "domainid", - "type": "string" - } - ] - }, - { - "description": "Lists projects and provides detailed information for listed projects", - "isasync": false, - "name": "listProjects", - "params": [ - { - "description": "comma separated list of project details requested, value can be a list of [ all, resource, min]", - "length": 255, - "name": "details", - "required": false, - "type": "list" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "disk write in MiB", + "name": "diskwrite", + "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 virtual machine", + "name": "id", + "type": "string" }, + {}, { - "description": "List projects by username", - "length": 255, - "name": "username", - "required": false, + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "flag to display the resource icon for projects", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "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 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 project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of 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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the 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": "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 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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the 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 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + } + ], + "type": "set" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "list projects by state", - "length": 255, - "name": "state", - "required": false, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "list projects by name", - "length": 255, - "name": "name", - "required": false, + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "List projects by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "list projects by project ID", - "length": 255, - "name": "id", - "related": "listProjectAccounts,activateProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "list projects by display text", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" - } - ], - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "response": [ + }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "disk read in MiB", + "name": "diskread", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "network write in MiB", + "name": "networkwrite", "type": "string" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the list of resource tags associated with vm", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -80890,23 +75142,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -80915,1695 +75167,1145 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the total disk iops", + "name": "diskiopstotal", "type": "long" }, - {}, { - "description": "the state of the project", - "name": "state", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the name of the project", + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the name of the virtual machine", "name": "name", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {}, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" } - ], - "since": "3.0.0" + ] }, { - "description": "Creates an account", + "description": "Lists hosts.", "isasync": false, - "name": "createAccount", + "name": "listHosts", "params": [ { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "", "length": 255, - "name": "timezone", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "userid", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Creates the account under the specified role.", + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "roleid", - "related": "importRole,listRoles,updateRole", + "name": "hahost", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Creates the user under the specified domain.", + "description": "the id of the host", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, "type": "uuid" }, { - "description": "Unique username.", + "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": "username", - "required": true, + "name": "outofbandmanagementpowerstate", + "required": false, "type": "string" }, { - "description": "lastname", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "lastname", - "required": true, - "type": "string" + "name": "virtualmachineid", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" }, { - "description": "details for account used to store specific parameters", + "description": "the host type", "length": 255, - "name": "accountdetails", + "name": "type", "required": false, - "type": "map" + "type": "string" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "description": "", "length": 255, - "name": "accounttype", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.", + "description": "the name of the host", "length": 255, - "name": "password", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "Account UUID, required for adding account from external provisioning system", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "accountid", + "name": "hypervisor", "required": false, "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": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "email", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "email", - "required": true, - "type": "string" + "name": "outofbandmanagementenabled", + "required": false, + "type": "boolean" }, { - "description": "Network domain for the account's networks", + "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": "networkdomain", + "name": "resourcestate", "required": false, "type": "string" }, { - "description": "firstname", + "description": "the Pod ID for the host", "length": 255, - "name": "firstname", - "required": true, - "type": "string" - } - ], - "related": "enableAccount,listAccounts,listAccounts", - "response": [ + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the state of the host", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", + "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": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the Zone ID for the host", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "declareHostAsDegraded,reconnectHost", + "response": [ + { + "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 account", - "name": "state", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, - {}, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "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": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "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 account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - } - ], - "type": "list" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + {}, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "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 total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", "type": "long" }, - {}, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + {}, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum 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": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the 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 total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" } ] }, { - "description": "Revert VM from a vmsnapshot.", - "isasync": true, - "name": "revertToVMSnapshot", + "description": "Deletes a storage pool.", + "isasync": false, + "name": "deleteStoragePool", "params": [ { - "description": "The ID of the vm snapshot", + "description": "Storage pool id", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": true, "type": "uuid" + }, + { + "description": "Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], - "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,deployVnfAppliance,importUnmanagedInstance,importVm", "response": [ + {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the 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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {} + ] + }, + { + "description": "Deletes an existing guest network IPv6 prefix.", + "isasync": true, + "name": "deleteGuestNetworkIpv6Prefix", + "params": [ { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, + "description": "Id of the guest network IPv6 prefix", + "length": 255, + "name": "id", + "related": "createGuestNetworkIpv6Prefix,listGuestNetworkIpv6Prefixes", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.17.0.0" + }, + { + "description": "Updates a storage pool.", + "isasync": false, + "name": "updateStoragePool", + "params": [ { - "description": "Base64 string containing the user data", - "name": "userdata", - "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": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the Id of the storage pool", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the URL of the storage pool", + "length": 255, + "name": "url", + "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "comma-separated list of tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, + "type": "list" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "Change the name of the storage pool", + "length": 255, + "name": "name", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.15", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "length": 255, + "name": "capacityiops", + "required": false, + "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "bytes CloudStack can provision from this storage pool", + "length": 255, + "name": "capacitybytes", + "required": false, "type": "long" }, { - "description": "Vm details in key/value pairs.", + "description": "the details for the storage pool", + "length": 255, "name": "details", + "required": false, + "since": "4.19.0", "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "description": "Whether the informed tag is a JS interpretable rule or not.", + "length": 255, + "name": "istagarule", + "required": false, + "type": "boolean" + } + ], + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "response": [ { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, { - "description": "the list of resource tags associated", + "description": "the tags for the storage pool", "name": "tags", - "response": [ - { - "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": "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 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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, + {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "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 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" - } - ], - "type": "set" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Storage provider for this pool", + "name": "provider", "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": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, - {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, - {}, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the ID of the availability zone for the virtual machine", + "description": "the Zone ID of the storage pool", "name": "zoneid", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the storage pool", + "name": "id", "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Lists Tungsten-Fabric tags", + "isasync": false, + "name": "listTungstenFabricTag", + "params": [ { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the uuid of Tungsten-Fabric vm", + "length": 255, + "name": "vmuuid", + "required": false, "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the uuid of Tungsten-Fabric nic", + "length": 255, + "name": "nicuuid", + "required": false, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the uuid of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", + "required": false, "type": "string" }, { - "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, "type": "string" }, { - "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the 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 virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "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 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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "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 account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the 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": "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": "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 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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "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" - }, - { - "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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - } - ], - "type": "set" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the uuid of Tungsten-Fabric network", + "length": 255, + "name": "networkuuid", + "required": false, "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - {}, - { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": false, "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "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 isolation uri of the nic", - "name": "isolationuri", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - } - ], - "type": "set" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "applyTungstenFabricTag", + "response": [ { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Tungsten-Fabric tag name", + "name": "name", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { - "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" } - ], - "since": "4.2.0" + ] }, { - "description": "Lists host tags", + "description": "Import LDAP users", "isasync": false, - "name": "listHostTags", + "name": "importLdapUsers", "params": [ { - "description": "List by keyword", + "description": "Creates the account under the specified role.", "length": 255, - "name": "keyword", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "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": "pagesize", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -82611,117 +76313,88 @@ "name": "page", "required": false, "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ID of the host tag", - "name": "id", - "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the host ID of the host tag", - "name": "hostid", - "type": "long" + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "length": 255, + "name": "accounttype", + "required": false, + "type": "integer" }, - {}, - {}, - { - "description": "the name of the host tag", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "Add a new guest OS type", - "isasync": true, - "name": "addGuestOs", - "params": [ { - "description": "Unique display name for Guest OS", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "osdisplayname", - "required": true, + "name": "timezone", + "required": false, "type": "string" }, { - "description": "ID of Guest OS category", + "description": "details for account used to store specific parameters", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", - "required": true, - "type": "uuid" + "name": "accountdetails", + "required": false, + "type": "map" }, { - "description": "Map of (key/value pairs)", + "description": "List by keyword", "length": 255, - "name": "details", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "whether this guest OS is available for end users", + "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": "forDisplay", + "name": "group", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Optional name for Guest OS", + "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": "name", + "name": "account", "required": false, "type": "string" } ], - "related": "", + "related": "searchLdap", "response": [ { - "description": "the name/description of the OS type", - "name": "description", + "description": "The user's principle", + "name": "principal", "type": "string" }, { - "description": "is the guest OS visible for the users", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the name of the OS type", - "name": "name", + "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 user's domain", + "name": "domain", + "type": "string" }, { - "description": "the ID of the OS type", - "name": "id", + "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 name of the OS category", - "name": "oscategoryname", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { @@ -82729,528 +76402,609 @@ "name": "jobid", "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" }, - {} + { + "description": "The user's username", + "name": "username", + "type": "string" + } ], - "since": "4.4.0" + "since": "4.3.0" }, { - "description": "add an annotation.", + "description": "Moves a domain and its children to a new parent domain.", "isasync": false, - "name": "addAnnotation", + "name": "moveDomain", "params": [ { - "description": "the annotation is visible for admins only", + "description": "The ID of the new parent domain of the domain to be moved.", "length": 255, - "name": "adminsonly", - "required": false, - "since": "4.16.0", - "type": "boolean" + "name": "parentdomainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" }, { - "description": "the id of the entity to annotate", + "description": "The ID of the domain to be moved.", "length": 255, - "name": "entityid", - "required": false, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": true, + "type": "uuid" + } + ], + "related": "createDomain,listDomains,listDomains", + "response": [ + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the annotation text", - "length": 255, - "name": "annotation", - "required": false, + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER", - "length": 255, - "name": "entitytype", - "required": false, - "type": "string" - } - ], - "related": "removeAnnotation,updateAnnotationVisibility", - "response": [ + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, - {}, { - "description": "the type of the annotated entity", - "name": "entitytype", - "type": "string" + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, - {}, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" }, { - "description": "the (uu)id of the annotation", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", - "type": "string" - } - ], - "since": "4.11" - }, - { - "description": "Removes a Guest OS Mapping.", - "isasync": true, - "name": "removeGuestOsMapping", - "params": [ - { - "description": "ID of the guest OS mapping", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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 domain name of the parent domain", + "name": "parentdomainname", "type": "string" - } - ], - "since": "4.4.0" - }, - { - "description": "create Tungsten-Fabric service group", - "isasync": true, - "name": "createTungstenFabricServiceGroup", - "params": [ + }, { - "description": "Tungsten-Fabric service group name", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "Tungsten-Fabric service group protocol", - "length": 255, - "name": "protocol", - "required": true, + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "Tungsten-Fabric service group end port", - "length": 255, - "name": "endport", - "required": true, - "type": "integer" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "Tungsten-Fabric service group start port", - "length": 255, - "name": "startport", - "required": true, - "type": "integer" - } - ], - "related": "", - "response": [ + "description": "the path of the domain", + "name": "path", + "type": "string" + }, { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "Tungsten-Fabric service group uuid", - "name": "uuid", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "Tungsten-Fabric service group end port", - "name": "endport", - "type": "int" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, - {}, { - "description": "Tungsten-Fabric service group name", - "name": "name", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" }, {}, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "Tungsten-Fabric service group protocol", - "name": "protocol", + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the state of the domain", + "name": "state", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + { + "description": "the name of the domain", + "name": "name", + "type": "string" + }, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + {}, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" } - ] + ], + "since": "4.19.0.0" }, { - "description": "Registers an existing ISO into the CloudStack Cloud.", + "description": "Lists all available networks.", "isasync": false, - "name": "registerIso", + "name": "listNetworks", "params": [ { - "description": "Register ISO for the project", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if you want this ISO to be featured", + "description": "type of the traffic", "length": 255, - "name": "isfeatured", + "name": "traffictype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "the ID or VID of the network", "length": 255, - "name": "directdownload", + "name": "vlan", "required": false, - "type": "boolean" + "since": "4.17.0", + "type": "string" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ispublic", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "bootable", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "boolean" - }, - { - "description": "the name of the ISO", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "ostypeid", - "related": "", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "the display text of the ISO, defaults to the 'name'", - "length": 4096, - "name": "displaytext", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", + "length": 255, + "name": "acltype", "required": false, "type": "string" }, { - "description": "an optional account name. Must be used with domainId.", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "account", + "name": "displaynetwork", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "true if password reset feature is supported; default is false", + "description": "list networks available for VM deployment", "length": 255, - "name": "passwordenabled", + "name": "canusefordeploy", "required": false, "type": "boolean" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", + "description": "flag to display the resource icon for networks", "length": 255, - "name": "isextractable", + "name": "showicon", "required": false, "type": "boolean" }, { - "description": "the ID of the zone you wish to register the ISO to.", + "description": "the network belongs to VPC", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "forvpc", + "required": false, + "type": "boolean" }, { - "description": "the checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "list networks by ID", "length": 255, - "name": "checksum", + "name": "id", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "description": "list networks by network offering ID", "length": 255, - "name": "isdynamicallyscalable", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Image store UUID", + "description": "list networks supporting certain services", "length": 255, - "name": "imagestoreuuid", + "name": "supportedservices", "required": false, - "type": "string" + "type": "list" }, { - "description": "the URL to where the ISO is currently being hosted", - "length": 2048, - "name": "url", - "required": true, - "type": "string" - } - ], - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "true if network is system, false otherwise", + "length": 255, + "name": "issystem", + "required": false, + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "list networks by restartRequired", + "length": 255, + "name": "restartrequired", + "required": false, "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "true if need to list only networks which support specifying IP ranges", + "length": 255, + "name": "specifyipranges", + "required": false, + "type": "boolean" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "List networks by associated networks. Only available if create a Shared network.", + "length": 255, + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "since": "4.17.0", + "type": "uuid" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "the zone ID of the network", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\".* account : account networks that have been registered for or created by the calling user. * domain : domain networks that have been registered for or created by the calling user. * accountdomain : account and domain networks that have been registered for or created by the calling user. * shared : networks that have been granted to the calling user by another user. * all : all networks (account, domain and shared).", + "length": 255, + "name": "networkfilter", + "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, "type": "boolean" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "list networks by physical network id", + "length": 255, + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "List networks by VPC", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "response": [ { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the template name", - "name": "name", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with network", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -83258,461 +77012,473 @@ "name": "account", "type": "string" }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" } ], - "type": "set" - }, - { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "type": "list" }, {}, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "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 ID of the domain to which the template belongs", - "name": "domainid", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "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 project name of the template", - "name": "project", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "zone id of the network", + "name": "zoneid", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the name of the zone for this template", - "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 ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { - "description": "the project id of the template", + "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, - {} - ] - }, - { - "description": "Lists Cisco ASA 1000v appliances", - "isasync": false, - "name": "listCiscoAsa1000vResources", - "params": [ { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "Cisco ASA 1000v resource ID", - "length": 255, - "name": "resourceid", - "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", - "required": false, - "type": "uuid" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", - "length": 255, - "name": "hostname", - "required": false, + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" - } - ], - "related": "addCiscoAsa1000vResource", - "response": [ - {}, - {}, + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The external id of the network", + "name": "externalid", + "type": "string" }, - {}, - {}, - {} - ] - }, - { - "description": "Creates new NS Vpx", - "isasync": true, - "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": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "The network this ip address should be associated to.", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the owner of the network", + "name": "account", + "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,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" }, { - "description": "availability zone for the virtual machine", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", - "response": [ + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, - {}, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "device name", - "name": "lbdevicename", - "type": "string" + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", + "description": "true if network is system, false otherwise", + "name": "issystem", "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 name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", - "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 device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", - "type": "string" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" - } - ] - }, - { - "description": "Lists the volumes of elastistor", - "isasync": false, - "name": "listElastistorVolume", - "params": [ - { - "description": "the ID of the account", - "length": 255, - "name": "id", - "required": true, + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "graceallowed", - "name": "graceallowed", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "synchronization", - "name": "sync", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "deduplication", - "name": "deduplication", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the id of the volume", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "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": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "the id of the network", "name": "id", "type": "string" }, { - "description": "the name of the volume", - "name": "name", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "compression", - "name": "compression", + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, - {}, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" } ] }, { - "description": "deletes a range of portable public IP's associated with a region", - "isasync": true, - "name": "deletePortableIpRange", + "description": "Releases an IP address from the account.", + "isasync": false, + "name": "releaseIpAddress", "params": [ { - "description": "Id of the portable ip range", + "description": "the ID of the public IP address to release", "length": 255, "name": "id", - "related": "", + "related": "associateIpAddress,reserveIpAddress,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", @@ -83720,197 +77486,281 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, {}, - {} - ] + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.17" }, { - "description": "add a baremetal pxe server", + "description": "Updates a management network IP range. Only allowed when no IPs are allocated.", "isasync": true, - "name": "addBaremetalPxeKickStartServer", + "name": "updatePodManagementNetworkIpRange", "params": [ { - "description": "the Physical Network ID", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": true, "type": "uuid" }, { - "description": "Tftp root directory of PXE server", - "length": 255, - "name": "tftpdir", - "required": true, - "type": "string" - }, - { - "description": "Credentials to reach external pxe device", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, - { - "description": "URL of the external pxe device", + "description": "The current ending IP address.", "length": 255, - "name": "url", + "name": "currentendip", + "related": "listPods,createManagementNetworkIpRange", "required": true, "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "The new ending IP address.", "length": 255, - "name": "password", - "required": true, + "name": "newendip", + "required": false, "type": "string" }, { - "description": "type of pxe device", + "description": "The current starting IP address.", "length": 255, - "name": "pxeservertype", + "name": "currentstartip", + "related": "listPods,createManagementNetworkIpRange", "required": true, "type": "string" }, { - "description": "Pod Id", + "description": "The new starting IP address.", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "newstartip", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "", "response": [ - { - "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" - }, - { - "description": "device id of ", - "name": "id", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "url", - "name": "url", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {} - ] + ], + "since": "4.16.0.0" }, { - "description": "Lists Nicira NVP devices", - "isasync": false, - "name": "listNiciraNvpDevices", + "description": "Updates firewall rule ", + "isasync": true, + "name": "updateFirewallRule", "params": [ { - "description": "nicira nvp device ID", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "the Physical Network ID", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "List by keyword", + "description": "the ID of the firewall rule", "length": 255, - "name": "keyword", - "required": false, + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": true, + "type": "uuid" + } + ], + "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", + "response": [ + { + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" - } - ], - "related": "addNiciraNvpDevice", - "response": [ + }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, + { + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "device name", - "name": "niciradevicename", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, + {}, { - "description": "the controller Ip address", - "name": "hostname", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.4" + }, + { + "description": "Return true if the plugin is enabled", + "isasync": false, + "name": "quotaIsEnabled", + "params": [], + "related": "", + "response": [ + { + "description": "is quota service enabled", + "name": "isenabled", + "type": "boolean" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -83918,79 +77768,157 @@ "type": "integer" }, { - "description": "name of the provider", - "name": "provider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} - ] + ], + "since": "4.7.0" }, { - "description": "Lists all alerts.", + "description": "Deletes the registered OAuth provider", "isasync": false, - "name": "listAlerts", + "name": "deleteOauthProvider", "params": [ { - "description": "the ID of the alert", + "description": "id of the OAuth provider to be deleted", "length": 255, "name": "id", - "related": "listAlerts", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.19.0" + }, + { + "description": "Creates a Bgp Peer for a zone.", + "isasync": true, + "name": "createBgpPeer", + "params": [ + { + "description": "UUID of the zone which the Bgp Peer belongs to.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "project who will own the Bgp Peer", + "length": 255, + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "The password of the Bgp Peer.", "length": 255, - "name": "keyword", + "name": "password", "required": false, "type": "string" }, { - "description": "", + "description": "The IPv6 address of the Bgp Peer.", "length": 255, - "name": "page", + "name": "ip6address", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list by alert type", + "description": "BGP peer details in key/value pairs.", "length": 255, - "name": "type", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "list by alert name", + "description": "domain ID of the account owning the Bgp Peer", "length": 255, - "name": "name", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "The IPv4 address of the Bgp Peer.", + "length": 255, + "name": "ipaddress", "required": false, - "since": "4.3", "type": "string" }, { - "description": "", + "description": "The AS number of the Bgp Peer.", "length": 255, - "name": "pagesize", + "name": "asnumber", + "required": true, + "type": "long" + }, + { + "description": "account who will own the Bgp Peer", + "length": 255, + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], - "related": "", + "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "response": [ {}, { - "description": "the date and time the alert was sent", - "name": "sent", - "type": "date" + "description": "password of bgp peer", + "name": "password", + "type": "string" }, { - "description": "the id of the alert", - "name": "id", + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the name of the alert", - "name": "name", + "description": "the account of the bgp peer", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { @@ -83998,1522 +77926,1548 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "description of the alert", - "name": "description", + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + { + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", - "name": "type", - "type": "short" + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" + }, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" + }, + { + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" + }, + { + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" } - ] + ], + "since": "4.20.0" }, { - "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", - "isasync": true, - "name": "deployVirtualMachine", + "description": "List hypervisors", + "isasync": false, + "name": "listHypervisors", "params": [ { - "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", + "description": "the zone id for listing hypervisors.", "length": 255, - "name": "rootdisksize", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.4", - "type": "long" + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Hypervisor name", + "name": "name", + "type": "string" + }, + {} + ] + }, + { + "description": "Dedicates an existing Bgp Peer to an account or a domain.", + "isasync": true, + "name": "dedicateBgpPeer", + "params": [ + { + "description": "domain ID of the account owning the Bgp Peer", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.13", "type": "uuid" }, { - "description": "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us", + "description": "account who will own the Bgp Peer", "length": 255, - "name": "keyboard", + "name": "account", "required": false, "type": "string" }, { - "description": "used to specify the vApp properties.", + "description": "Id of the Bgp Peer", "length": 255, - "name": "properties", - "required": false, - "since": "4.15", - "type": "map" + "name": "id", + "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", + "required": true, + "type": "uuid" }, { - "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "description": "project who will own the Bgp Peer", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" + } + ], + "related": "listBgpPeers,releaseBgpPeer", + "response": [ + { + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "description": "the ip address for default vm's network", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "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": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "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, + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, + "description": "the account of the bgp peer", "name": "account", - "required": false, "type": "string" }, { - "description": "host name for the virtual machine", - "length": 255, - "name": "name", - "required": false, + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "the mac address for default vm's network", - "length": 255, - "name": "macaddress", - "required": false, + "description": "password of bgp peer", + "name": "password", "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": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" }, { - "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", - "length": 255, - "name": "securitygroupids", - "related": "createSecurityGroup", - "required": false, - "type": "list" + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" + }, + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" + }, + {}, + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + { + "description": "IPv4 address of bgp peer", + "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" + } + ], + "since": "4.20.0" + }, + { + "description": "Lists hosts metrics", + "isasync": false, + "name": "listHostsMetrics", + "params": [ + { + "description": "if true, list only hosts dedicated to HA", "length": 255, - "name": "dynamicscalingenabled", + "name": "hahost", "required": false, - "since": "4.16", "type": "boolean" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "the state of the host", "length": 255, - "name": "keypair", + "name": "state", "required": false, "type": "string" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", "length": 255, - "name": "keypairs", + "name": "details", "required": false, - "since": "4.17", "type": "list" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, "type": "uuid" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the ipv6 address for default vm's network", + "description": "the host type", "length": 255, - "name": "ip6address", + "name": "type", "required": false, "type": "string" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "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, - "since": "4.12", "type": "string" }, { - "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "description": "List by keyword", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "the ID of the Userdata", + "description": "", "length": 255, - "name": "userdataid", - "related": "", + "name": "pagesize", "required": false, - "since": "4.18", - "type": "uuid" + "type": "integer" }, { - "description": "Controls specific policies on IO", + "description": "the id of the host", "length": 255, - "name": "iodriverpolicy", + "name": "id", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "name": "outofbandmanagementenabled", + "required": false, + "type": "boolean" }, { - "description": "the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "description": "the name of the host", "length": 255, - "name": "hypervisor", + "name": "name", "required": false, "type": "string" }, { - "description": "The number of queues for multiqueue NICs.", + "description": "the Zone ID for the host", "length": 255, - "name": "nicmultiqueuenumber", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.18", - "type": "integer" + "type": "uuid" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "the Pod ID for the host", "length": 255, - "name": "startvm", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "description": "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": "iptonetworklist", + "name": "resourcestate", "required": false, - "type": "map" + "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "userdatadetails", + "name": "virtualmachineid", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": false, - "since": "4.18", - "type": "map" + "type": "uuid" }, { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "password", + "name": "hypervisor", "required": false, - "since": "4.19.0.0", "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", - "length": 255, - "name": "deploymentplanner", - "required": false, - "since": "4.4", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", - "length": 255, - "name": "iothreadsenabled", - "required": false, - "type": "boolean" + "description": "out-of-band management power state", + "name": "powerstate", + "type": "powerstate" }, + {}, { - "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", - "length": 255, - "name": "datadiskofferinglist", - "required": false, - "since": "4.11", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "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 resource state of the host", + "name": "resourcestate", + "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, + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", "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,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "list" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "Enable packed virtqueues or not.", - "length": 255, - "name": "nicpackedvirtqueuesenabled", - "required": false, - "since": "4.18", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, { - "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", - "length": 255, - "name": "overridediskofferingid", - "related": "createDiskOffering", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "an optional group for the virtual machine", - "length": 255, - "name": "group", - "required": false, + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", - "length": 255, - "name": "boottype", - "required": false, - "since": "4.14.0.0", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "network read in GiB", + "name": "networkread", "type": "string" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", - "length": 255, - "name": "affinitygroupnames", - "related": "", - "required": false, - "type": "list" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", - "length": 255, - "name": "bootmode", - "required": false, - "since": "4.14.0.0", + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" + }, + { + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "availability zone for the virtual machine", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "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", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", + "type": "string" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", - "length": 255, - "name": "copyimagetags", - "required": false, - "since": "4.13", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, { - "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": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "an optional user generated name for the virtual machine", - "length": 255, - "name": "displayname", - "required": false, + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "system vm instances on the host", + "name": "systeminstances", "type": "string" }, { - "description": "Deploy vm for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", - "length": 255, - "name": "size", - "required": false, + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "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", + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", + "type": "string" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the total memory used in GiB", + "name": "memoryusedgb", + "type": "string" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" + }, + { + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", "type": "boolean" - } - ], - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ + }, + {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "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": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" + }, + { + "description": "GPU cards present in the host", + "name": "gpugroup", "response": [ { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of enabled vGPUs", + "name": "vgpu", "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": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "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": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag 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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" } ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "type": "list" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "GPU cards present in the host", + "name": "gpugroupname", "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": "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": "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": "id of the resource", - "name": "resourceid", - "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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "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 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "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": "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 ending IP of the security group rule ", - "name": "endport", - "type": "integer" - } - ], - "type": "set" } ], - "type": "set" + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "instances on the host", + "name": "instances", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "capabilities of the host", + "name": "capabilities", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "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 id of userdata used for the VM", - "name": "userdataid", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "network write in GiB", + "name": "networkwrite", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the total memory capacity in GiB", + "name": "memorytotalgb", + "type": "string" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the average cpu load the last minute", + "name": "cpuloadaverage", + "type": "double" + }, + { + "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": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, - {}, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the total cpu capacity in Ghz", + "name": "cputotalghz", "type": "string" }, - {}, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" + } + ], + "since": "4.9.3" + }, + { + "description": "Release the dedication for the pod", + "isasync": true, + "name": "releaseDedicatedPod", + "params": [ + { + "description": "the ID of the Pod", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the current status 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 name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Lists affinity groups", + "isasync": false, + "name": "listAffinityGroups", + "params": [ + { + "description": "lists affinity groups by type", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "lists affinity groups by virtual machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "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": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "lists affinity groups by name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "list the affinity group by the ID provided", + "length": 255, + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", + "required": false, + "type": "uuid" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, - {}, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" + } + ], + "related": "createAffinityGroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, + {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + {}, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Cancels a triggered shutdown", + "isasync": false, + "name": "cancelShutdown", + "params": [ + { + "description": "the uuid of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": true, + "type": "uuid" + } + ], + "related": "prepareForShutdown,readyForShutdown", + "response": [ + { + "description": "The id of the management server", + "name": "managementserverid", + "type": "long" + }, + {}, + {}, + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", "type": "boolean" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account associated with the virtual machine", + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Register a public key in a keypair under a certain name", + "isasync": false, + "name": "registerSSHKeyPair", + "params": [ + { + "description": "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Name of the keypair", + "length": 255, + "name": "name", + "required": true, + "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", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, "name": "account", + "required": false, + "type": "string" + } + ], + "related": "listSSHKeyPairs", + "response": [ + { + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, + {}, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project name of the vm", + "description": "Fingerprint of the public key", + "name": "fingerprint", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Name of the keypair", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the keypair owner", "name": "project", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the project id of the keypair owner", + "name": "projectid", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, + {} + ] + }, + { + "description": "Reserve a public IP to an account.", + "isasync": false, + "name": "reserveIpAddress", + "params": [ { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the account to reserve with this IP address", + "length": 255, + "name": "account", + "required": false, + "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 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", - "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 description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the domain to reserve with this IP address", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the 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": "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": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "the ID of the public IP address to reserve", + "length": 255, + "name": "id", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "an optional field, whether to the display the IP to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the ID of the project to reserve with this IP address", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + } + ], + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + {}, + { + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", + "description": "the domain the public IP address is associated with", "name": "domain", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", + "description": "date the public IP address was acquired", + "name": "allocated", "type": "date" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "the list of resource tags associated with ip address", + "name": "tags", "response": [ { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "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 nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "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": "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "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 vpc to which the nic belongs", - "name": "vpcid", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" } - ] + ], + "since": "4.17" }, { - "description": "Upgrades router to use newer template", + "description": "Delete one or more events.", "isasync": false, - "name": "upgradeRouterTemplate", + "name": "deleteEvents", "params": [ { - "description": "upgrades all routers within the specified cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "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 owned by the specified account", + "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": "account", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { - "description": "upgrades all routers within the specified zone", + "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": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "upgrades router with the specified Id", + "description": "the IDs of the events", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters", + "name": "ids", + "related": "", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "upgrades all routers owned by the specified domain", + "description": "delete by event type", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "type", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "", "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", @@ -85525,939 +79479,1198 @@ "type": "integer" }, {}, - {} + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { - "description": "Cancels host maintenance.", + "description": "Deletes an ISO file.", "isasync": true, - "name": "cancelHostMaintenance", + "name": "deleteIso", "params": [ { - "description": "the host ID", + "description": "the ID of the ISO file", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" + }, + { + "description": "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": "listZones", + "required": false, + "type": "uuid" } ], - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", "response": [ { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {}, { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Lists VPC offerings", + "isasync": false, + "name": "listVPCOfferings", + "params": [ + { + "description": "list VPC offerings by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "list VPC offerings by display text", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if need to list only default VPC offerings. Default value is false", + "length": 255, + "name": "isdefault", + "required": false, + "type": "boolean" }, { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", + "description": "list VPC offerings by id", + "length": 255, + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", + "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": "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": "id of zone VPC offering is associated with", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.13", + "type": "uuid" + }, + { + "description": "list VPC offerings available for VPC creation in specific domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "since": "4.18", + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "updateVPCOffering", + "response": [ + { + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", "type": "boolean" }, { - "description": "events available for the host", - "name": "events", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", "type": "boolean" }, { - "description": "the host version", - "name": "version", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + {}, + { + "description": "the list of supported services", + "name": "service", "response": [ { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the list of enabled vGPUs", - "name": "vgpu", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" + "description": "the provider name", + "name": "name", + "type": "string" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" }, { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "Model Name of vGPU", - "name": "vgputype", + "description": "state of the network provider", + "name": "state", "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": "the physical network this belongs to", + "name": "physicalnetworkid", + "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": "uuid of the network provider", + "name": "id", + "type": "string" } ], "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the name of the vpc offering", + "name": "name", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + } + ] + }, + { + "description": "Get the SF volume size including Hypervisor Snapshot Reserve", + "isasync": false, + "name": "getSolidFireVolumeSize", + "params": [ + { + "description": "Volume UUID", + "length": 255, + "name": "volumeid", + "required": true, "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "SolidFire Volume Size Including Hypervisor Snapshot Reserve", + "name": "solidFireVolumeSize", "type": "long" + } + ] + }, + { + "description": "Uploads a data disk.", + "isasync": true, + "name": "uploadVolume", + "params": [ + { + "description": "the name of the volume", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the zone the volume is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "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 ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "Upload volume for the project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" + "description": "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", + "required": true, "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, + "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "Image store uuid", + "length": 255, + "name": "imagestoreuuid", + "required": false, "type": "string" + } + ], + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "response": [ + { + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, - {}, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "the date the volume was attached to a VM instance", + "name": "attached", "type": "date" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, + {}, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "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 disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "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 name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, + {}, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - } - ] - }, - { - "description": "Lists all VLAN IP ranges.", - "isasync": false, - "name": "listVlanIpRanges", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "project who will own the VLAN", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the VLAN IP range", - "length": 255, - "name": "id", - "related": "updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "required": false, - "type": "uuid" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", - "length": 255, - "name": "vlan", - "required": false, + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "true if VLAN is of Virtual type, false if Direct", - "length": 255, - "name": "forvirtualnetwork", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the Zone ID of the VLAN IP range", - "length": 255, + "description": "ID of the availability zone", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "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.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "network id of the VLAN IP range", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "the Pod ID of the VLAN IP range", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "physical network id of the VLAN IP range", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - } - ], - "related": "updateVlanIpRange,dedicatePublicIpRange", - "response": [ - { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "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": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, - {}, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the project id of the vlan range", - "name": "projectid", - "type": "string" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "the project name of the vlan range", - "name": "project", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "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 of the VLAN IP range", - "name": "account", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "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 gateway of the VLAN IP range", - "name": "gateway", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, - {}, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "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 account associated with the disk volume", + "name": "account", "type": "string" } ] }, { - "description": "Updates a Zone.", + "description": "Configures a host's out-of-band management interface", "isasync": false, - "name": "updateZone", + "name": "configureOutOfBandManagement", "params": [ { - "description": "the second DNS for the Zone", + "description": "the host management interface password", "length": 255, - "name": "dns2", - "required": false, + "name": "password", + "required": true, "type": "string" }, { - "description": "the second internal DNS for the Zone", + "description": "the host management interface IP address", "length": 255, - "name": "internaldns2", - "required": false, + "name": "address", + "required": true, "type": "string" }, { - "description": "the details for the Zone", + "description": "the host management interface port", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "port", + "required": true, + "type": "string" }, { - "description": "sort key of the zone, integer", + "description": "the ID of the host", "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": true, + "type": "uuid" }, { - "description": "the name of the Zone", + "description": "the host management interface user", "length": 255, - "name": "name", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "the host management interface driver, for example: ipmitool", "length": 255, - "name": "ip6dns1", - "required": false, + "name": "driver", + "required": true, + "type": "string" + } + ], + "related": "enableOutOfBandManagementForHost,changeOutOfBandManagementPassword", + "response": [ + {}, + { + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "updates a private zone to public if set, but not vice-versa", - "length": 255, - "name": "ispublic", - "required": false, + "description": "the out-of-band management driver for the host", + "name": "driver", + "type": "string" + }, + { + "description": "the operation result", + "name": "status", "type": "boolean" }, { - "description": "the dhcp Provider for the Zone", - "length": 255, - "name": "dhcpprovider", - "required": false, + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the first DNS for the Zone", - "length": 255, - "name": "dns1", - "required": false, + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", - "length": 255, - "name": "ip6dns2", - "required": false, + "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 dns search order list", - "length": 255, - "name": "dnssearchorder", - "required": false, - "type": "list" + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" }, { - "description": "the guest CIDR address for the Zone", - "length": 255, - "name": "guestcidraddress", - "required": false, + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "length": 255, - "name": "localstorageenabled", - "required": false, - "type": "boolean" + "description": "the out-of-band management interface password", + "name": "password", + "type": "string" }, { - "description": "the ID of the Zone", - "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, { - "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], + "since": "4.9.0" + }, + { + "description": "Lists storage tags", + "isasync": false, + "name": "listStorageTags", + "params": [ + { + "description": "", "length": 255, - "name": "domain", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "List by keyword", "length": 255, - "name": "allocationstate", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the first internal DNS for the Zone", + "description": "", "length": 255, - "name": "internaldns1", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], - "related": "createZone,listZones,listZones", + "related": "", "response": [ { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "description": "the pool ID of the storage tag", + "name": "poolid", + "type": "long" }, { - "description": "Zone description", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "the name of the storage tag", + "name": "name", + "type": "string" }, + {}, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the ID of the storage tag", + "name": "id", "type": "string" }, + {} + ] + }, + { + "description": "Creates a IPv4 subnet for guest networks.", + "isasync": true, + "name": "createIpv4SubnetForGuestNetwork", + "params": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", + "length": 255, + "name": "cidrsize", + "required": false, + "type": "integer" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "The CIDR of this Ipv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, "type": "string" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "The zone Ipv4 subnet which the IPv4 subnet belongs to.", + "length": 255, + "name": "parentid", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "id of the data center IPv4 subnet", + "name": "parentid", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "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": "resource type", - "name": "resourcetype", - "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, - {}, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "subnet of the IPv4 network", + "name": "subnet", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" }, + {}, { - "description": "Zone Token", - "name": "zonetoken", + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", "type": "string" }, + {}, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { - "description": "Zone id", + "description": "id of the IPv4 subnet for guest network", "name": "id", "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Delete VM Schedule.", + "isasync": false, + "name": "deleteVMSchedule", + "params": [ + { + "description": "IDs of VM schedule", + "length": 255, + "name": "ids", + "related": "", + "required": false, + "type": "list" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "ID of VM schedule", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "ID of VM", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -86465,165 +80678,148 @@ "type": "integer" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {}, { - "description": "Zone name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "List template visibility and all accounts that have permissions to view this template.", + "isasync": false, + "name": "listTemplatePermissions", + "params": [ + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "listIsoPermissions,listTemplatePermissions,listTemplatePermissions,listIsoPermissions", + "required": true, + "type": "uuid" + } + ], + "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", + "response": [ + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the capacity of the Zone", - "name": "capacity", - "response": [ - { - "description": "the Cluster ID", - "name": "clusterid", - "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 capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "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 Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - } - ], + "description": "the list of projects the template is available for", + "name": "projectids", "type": "list" }, + {}, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the template ID", + "name": "id", "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": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" + }, + { + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Extracts volume", - "isasync": true, - "name": "extractVolume", + "description": "Lists annotations.", + "isasync": false, + "name": "listAnnotations", "params": [ { - "description": "the ID of the volume", + "description": "the id of the annotation", "length": 255, "name": "id", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "required": false, + "type": "string" }, { - "description": "the ID of the zone where the volume is located", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "the id of the entity for which to show annotations", "length": 255, - "name": "mode", - "required": true, + "name": "entityid", + "required": false, "type": "string" }, { - "description": "the url to which the volume would be extracted", - "length": 2048, - "name": "url", + "description": "the entity type", + "length": 255, + "name": "entitytype", "required": false, "type": "string" - } - ], - "related": "downloadImageStoreObject,extractTemplate", - "response": [ + }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "possible values are \"self\" and \"all\". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access", + "length": 255, + "name": "annotationfilter", + "required": false, + "since": "4.16.0", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "optional: the id of the user of the annotation", + "length": 255, + "name": "userid", + "required": false, + "since": "4.16.0", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", - "type": "string" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "addAnnotation", + "response": [ { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { @@ -86631,235 +80827,304 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "zone ID the object was extracted from", - "name": "zoneid", - "type": "string" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, { - "description": "the id of extracted object", - "name": "id", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", - "type": "string" + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" }, { - "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, + {}, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "type": "string" }, - {}, { - "description": "", - "name": "resultstring", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" - }, - {} - ] + } + ], + "since": "4.11" }, { - "description": "Lists project's accounts", + "description": "Adds Swift.", "isasync": false, - "name": "listProjectAccounts", + "name": "addSwift", "params": [ { - "description": "list accounts of the project by role", + "description": "the username for swift", "length": 255, - "name": "role", + "name": "username", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": " key for the user for swift", "length": 255, - "name": "keyword", + "name": "key", "required": false, "type": "string" }, { - "description": "list accounts of the project by account name", + "description": "the URL for swift", "length": 255, - "name": "account", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "list accounts of the project by project role id", + "description": "the account for swift", "length": 255, - "name": "projectroleid", - "related": "updateProjectRole", + "name": "account", "required": false, - "type": "uuid" - }, + "type": "string" + } + ], + "related": "addSecondaryStorage,listSwifts,addImageStore", + "response": [ { - "description": "ID of the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,suspendProject,updateProject", - "required": true, - "type": "uuid" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "list invitation by user ID", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": false, - "type": "uuid" + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "activateProject,suspendProject,updateProject", - "response": [ - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", + "description": "the total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", + "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 total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the image store", + "name": "name", "type": "string" }, + {}, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the url of the image store", + "name": "url", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "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" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists snapshot policies.", + "isasync": false, + "name": "listSnapshotPolicies", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "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", + "required": false, "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {}, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the snapshot policy", + "length": 255, + "name": "id", + "related": "updateSnapshotPolicy,listSnapshotPolicies", + "required": false, + "type": "uuid" + } + ], + "related": "updateSnapshotPolicy", + "response": [ + { + "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 total number of vpcs the project can own", - "name": "vpclimit", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "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": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" }, + {}, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of resource tags associated with vm", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -86868,1725 +81133,1920 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" - }, + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + } + ] + }, + { + "description": "Update site to site vpn customer gateway", + "isasync": true, + "name": "updateVpnCustomerGateway", + "params": [ { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike", + "length": 255, + "name": "ikeversion", + "required": false, + "since": "4.15.1", "type": "string" }, { - "description": "the state of the project", - "name": "state", - "type": "string" + "description": "the domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "public ip address id of the customer gateway", + "length": 255, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "esplifetime", + "required": false, + "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "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" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "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": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "updateVpnCustomerGateway", + "required": true, + "type": "uuid" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "name of this customer gateway", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", + "length": 255, + "name": "ipsecpsk", + "required": true, "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "If DPD is enabled for VPN connection", + "length": 255, + "name": "dpd", + "required": false, + "type": "boolean" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "ESP policy of the customer gateway", + "length": 255, + "name": "esppolicy", + "required": true, "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "Force encapsulation for Nat Traversal", + "length": 255, + "name": "forceencap", + "required": false, + "type": "boolean" }, { - "description": "the name of the project", - "name": "name", + "description": "IKE policy of the customer gateway", + "length": 255, + "name": "ikepolicy", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "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 total number of networks the project can own", - "name": "networklimit", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the owner", + "name": "account", + "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", "type": "long" }, + {}, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "name of the customer gateway", + "name": "name", + "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "IPsec policy of customer gateway", + "name": "esppolicy", + "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" } - ], - "since": "3.0.0" + ] }, { - "description": "Updates an existing autoscale policy.", + "description": "apply Tungsten-Fabric tag", "isasync": true, - "name": "updateAutoScalePolicy", + "name": "applyTungstenFabricTag", "params": [ { - "description": "the duration in which the conditions have to be true before action is taken", + "description": "the uuid of vms", "length": 255, - "name": "duration", + "name": "vmuuid", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the cool down period in which the policy should not be evaluated after the action has been taken", + "description": "the uuid of nics", "length": 255, - "name": "quiettime", + "name": "nicuuid", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the name of the autoscale policy", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "name", + "name": "applicationpolicysetuuid", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the ID of the autoscale policy", + "description": "the uuid of networks", "length": 255, - "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", - "required": true, - "type": "uuid" + "name": "networkuuid", + "required": false, + "type": "list" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "conditionids", - "related": "", + "name": "policyuuid", "required": false, - "type": "list" - } - ], - "related": "listAutoScalePolicies", - "response": [ - { - "description": "the domain name of the autoscale policy", - "name": "domain", "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the uuid of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", + "required": true, + "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 ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", - "type": "string" + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" }, { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the account owning the autoscale policy", - "name": "account", - "type": "string" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, - {}, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ] }, { - "description": "Creates a disk offering.", + "description": "Updates object storage pool", "isasync": false, - "name": "createDiskOffering", + "name": "updateObjectStoragePool", "params": [ { - "description": "burst bytes read rate of the disk offering", + "description": "the name for the object store", "length": 255, - "name": "bytesreadratemax", + "name": "name", "required": false, - "type": "long" + "type": "string" }, { - "description": "Volumes using this offering should be encrypted", + "description": "the url for the object store", "length": 255, - "name": "encrypt", + "name": "url", "required": false, - "since": "4.18", - "type": "boolean" + "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "Object Store ID", "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "type": "long" + "name": "id", + "related": "addObjectStoragePool,updateObjectStoragePool", + "required": true, + "type": "uuid" + } + ], + "related": "addObjectStoragePool", + "response": [ + { + "description": "the name of the object store", + "name": "name", + "type": "string" }, { - "description": "whether disk offering iops is custom or not", - "length": 255, - "name": "customizediops", - "required": false, - "type": "boolean" + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" }, { - "description": "details to specify disk offering parameters", - "length": 255, - "name": "details", - "required": false, - "since": "4.16", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopsreadratemaxlength", - "required": false, - "type": "long" + "description": "the url of the object store", + "name": "url", + "type": "string" }, { - "description": "bytes read rate of the disk offering", - "length": 255, - "name": "bytesreadrate", - "required": false, - "type": "long" + "description": "the provider name of the object store", + "name": "providername", + "type": "string" }, + {}, { - "description": "whether disk offering size is custom or not", - "length": 255, - "name": "customized", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "burst io requests write rate of the disk offering", - "length": 255, - "name": "iopswriteratemax", - "required": false, - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "length": 255, - "name": "byteswriteratemax", - "required": false, + "description": "the object store currently used size", + "name": "storageused", "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "the ID of the object store", + "name": "id", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "This deprecated function used to locks an account. Look for the API DisableAccount instead", + "isasync": false, + "name": "lockAccount", + "params": [ + { + "description": "Locks the specified account on this domain.", "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "type": "long" + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "description": "name of the disk offering", + "description": "Locks the specified account.", "length": 255, - "name": "name", + "name": "account", "required": true, "type": "string" + } + ], + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "response": [ + {}, + { + "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": "the ID of the containing zone(s), null for public offerings", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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 total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "length": 255, - "name": "cachemode", - "required": false, - "since": "4.14", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the storage type of the disk offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", - "length": 255, - "name": "hypervisorsnapshotreserve", - "required": false, - "type": "integer" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", - "required": false, - "type": "long" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "io requests write rate of the disk offering", - "length": 255, - "name": "iopswriterate", - "required": false, - "type": "long" + "description": "the default zone of the account", + "name": "defaultzoneid", + "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": "the date when this account was created", + "name": "created", + "type": "date" }, { - "description": "tags for the disk offering", - "length": 4096, - "name": "tags", - "required": false, + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "max iops of the disk offering", - "length": 255, - "name": "maxiops", - "required": false, - "type": "long" + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" }, { - "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", - "length": 255, - "name": "disksize", - "required": false, + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, + {}, { - "description": "burst requests read rate of the disk offering", - "length": 255, - "name": "iopsreadratemax", - "required": false, - "type": "long" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "length": 255, - "name": "provisioningtype", - "required": false, + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the ID of the containing domain(s), null for public offerings", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + } + ], "type": "list" }, { - "description": "bytes write rate of the disk offering", - "length": 255, - "name": "byteswriterate", - "required": false, - "type": "long" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "io requests read rate of the disk offering", - "length": 255, - "name": "iopsreadrate", - "required": false, - "type": "long" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "min iops of the disk offering", - "length": 255, - "name": "miniops", - "required": false, + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "length": 255, - "name": "disksizestrictness", - "required": false, - "since": "4.17", - "type": "boolean" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "An alternate display text of the disk offering, defaults to 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", + "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": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, - {}, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed", - "name": "disksizestrictness", - "type": "boolean" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, - {}, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "unique ID of the disk offering", + "description": "the id of the account", "name": "id", "type": "string" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "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 state of the account", + "name": "state", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" } ] }, { - "description": "Lists all volumes.", - "isasync": false, - "name": "listVolumes", + "description": "Stops a router.", + "isasync": true, + "name": "stopRouter", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", "length": 255, - "name": "displayvolume", + "name": "forced", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "the cluster id the disk volume belongs to", + "description": "the ID of the router", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, + "name": "id", + "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, "type": "uuid" - }, + } + ], + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ { - "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", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the IDs of the volumes, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "attachVolume,createVolume,listVolumes,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "since": "4.9", - "type": "list" - }, - { - "description": "list volumes on specified host", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", - "length": 255, - "name": "state", - "required": false, + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the pod id the disk volume belongs to", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "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 domain ID associated with the router", + "name": "domainid", + "type": "string" }, { - "description": "the name of the disk volume", - "length": 255, - "name": "name", - "required": false, + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "listsystemvms", - "required": false, - "since": "4.18", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "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 name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" }, { - "description": "the ID of the availability zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" + "description": "the account associated with the router", + "name": "account", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "the type of disk volume", - "length": 255, - "name": "type", - "required": false, + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "list volumes by disk offering", - "length": 255, - "name": "diskofferingid", - "related": "", - "required": false, - "since": "4.4", - "type": "uuid" - } - ], - "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the domain associated with the disk volume", + "description": "the domain associated with the router", "name": "domain", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the path of the volume", - "name": "path", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "pod name of the volume", + "description": "the Pod name for the router", "name": "podname", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "name of the disk volume", - "name": "name", - "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": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "role of the domain router", + "name": "role", "type": "string" }, + {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, + {}, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" }, { - "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": "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": "the project id of the vpn", - "name": "projectid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "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 ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the 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 vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "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": "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the 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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" } ], "type": "set" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the 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 bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" - }, + } + ] + }, + { + "description": "Deletes project invitation", + "isasync": true, + "name": "deleteProjectInvitation", + "params": [ { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, + "description": "id of the invitation", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {}, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - {}, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "3.0.0" }, { - "description": "Creates a load balancer health check policy", + "description": "create Tungsten-Fabric firewall policy", "isasync": true, - "name": "createLBHealthCheckPolicy", + "name": "createTungstenFabricFirewallPolicy", "params": [ { - "description": "Amount of time between health checks (1 sec - 20940 sec)", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "intervaltime", + "name": "applicationpolicysetuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ID of zone", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the description of the load balancer health check policy", + "description": "Tungsten-Fabric firewall policy name", "length": 255, - "name": "description", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the ID of the load balancer rule", + "description": "the sequence of Tungsten-Fabric firewall policy", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", + "name": "sequence", "required": true, - "type": "uuid" + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy", - "length": 255, - "name": "unhealthythreshold", - "required": false, - "type": "integer" + "description": "Tungsten-Fabric firewall policy name", + "name": "name", + "type": "string" }, { - "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", - "length": 255, - "name": "responsetimeout", - "required": false, + "description": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Number of consecutive health check success before declaring an instance healthy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ] + }, + { + "description": "Updates a region", + "isasync": false, + "name": "updateRegion", + "params": [ + { + "description": "updates region with this name", "length": 255, - "name": "healthythreshold", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "HTTP ping path", + "description": "updates region with this end point", "length": 255, - "name": "pingpath", + "name": "endpoint", "required": false, "type": "string" + }, + { + "description": "Id of region to update", + "length": 255, + "name": "id", + "required": true, + "type": "integer" } ], - "related": "listLBHealthCheckPolicies", + "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" }, - {}, { - "description": "the account of the HealthCheck policy", - "name": "account", + "description": "the end point of the region", + "name": "endpoint", "type": "string" }, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "the name of the region", + "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 domain of the HealthCheck policy", - "name": "domain", - "type": "string" + "description": "the ID of the region", + "name": "id", + "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": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" - }, - { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" - }, - { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" - }, - { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" - } - ], - "type": "list" + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" }, { - "description": "the id of the zone the HealthCheck policy belongs to", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ], - "since": "4.2.0" + ] }, { - "description": "Locks a user account", - "isasync": false, - "name": "lockUser", + "description": "Deletes traffic type of a physical network", + "isasync": true, + "name": "deleteTrafficType", "params": [ { - "description": "Locks user by user ID.", + "description": "traffic type id", "length": 255, "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "related": "addTrafficType,updateTrafficType", "required": true, "type": "uuid" } ], - "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", "response": [ + {}, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "any text associated with the success or failure", + "name": "displaytext", "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", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Destroy a Shared FileSystem by id", + "isasync": true, + "name": "destroySharedFileSystem", + "params": [ + { + "description": "If true is passed, the shared filesystem can be destroyed without stopping it first.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "the ID of the shared filesystem to delete", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": false, + "type": "uuid" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "If true is passed, the shared filesystem is expunged immediately. False by default.", + "length": 255, + "name": "expunge", + "required": false, + "type": "boolean" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "Lists a project's project role permissions", + "isasync": false, + "name": "listProjectRolePermissions", + "params": [ { - "description": "the user name", - "name": "username", - "type": "string" + "description": "ID of the project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": true, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the user email address", - "name": "email", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the ID of the project", + "name": "projectid", + "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the description of the role permission", + "name": "description", + "type": "string" }, + {}, { - "description": "the user lastname", - "name": "lastname", + "description": "the ID of the project role to which the role permission belongs", + "name": "projectroleid", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the ID of the project role permission", + "name": "id", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.15.0" + }, + { + "description": "Lists all LDAP configurations", + "isasync": false, + "name": "listLdapConfigurations", + "params": [ + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": false, "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "If set to true, and no domainid specified, list all LDAP configurations irrespective of the linked domain", + "length": 255, + "name": "listall", + "required": false, + "since": "4.13.2", "type": "boolean" }, - {}, { - "description": "the account type of the user", - "name": "accounttype", + "description": "Port", + "length": 255, + "name": "port", + "required": false, "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, - {}, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } - ] - }, - { - "description": "Checks if the Cloudian Connector is enabled", - "isasync": false, - "name": "cloudianIsEnabled", - "params": [], - "related": "", + ], + "related": "addLdapConfiguration", "response": [ { - "description": "the Cloudian connector enabled state", - "name": "enabled", - "type": "boolean" + "description": "linked domain", + "name": "domainid", + "type": "string" }, { - "description": "the Cloudian Management Console base URL", - "name": "url", + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "port the ldap server is running on", + "name": "port", + "type": "int" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], - "since": "4.11.0" + "since": "4.2.0" }, { - "description": "Lists load balancer health check policies.", - "isasync": false, - "name": "listLBHealthCheckPolicies", + "description": "Creates a l2tp/ipsec remote access vpn", + "isasync": true, + "name": "createRemoteAccessVpn", "params": [ { - "description": "", + "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, - "name": "pagesize", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the load balancer rule", + "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "an optional account for the VPN. Must be used with domainId.", "length": 255, - "name": "fordisplay", + "name": "account", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "", + "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": "page", + "name": "iprange", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", "length": 255, - "name": "keyword", + "name": "openfirewall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the health check policy", + "description": "public ip address id of the vpn server", "length": 255, - "name": "id", - "related": "listLBHealthCheckPolicies", - "required": false, - "since": "4.4", + "name": "publicipid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, "type": "uuid" } ], - "related": "", + "related": "listRemoteAccessVpns", "response": [ { - "description": "the domain of the HealthCheck policy", - "name": "domain", - "type": "string" - }, - { - "description": "the account of the HealthCheck policy", + "description": "the account of the remote access vpn", "name": "account", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { @@ -88594,461 +83054,565 @@ "name": "jobid", "type": "string" }, - { - "description": "the list of healthcheckpolicies", - "name": "healthcheckpolicy", - "response": [ - { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" - }, - { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "type": "int" - }, - { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, - { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", - "type": "int" - }, - { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" - }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", - "type": "int" - } - ], - "type": "list" - }, - {}, - { - "description": "the 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.2.0" - }, - { - "description": "Creates a network", - "isasync": false, - "name": "createNetwork", - "params": [ - { - "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": "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": "IPV4 address to be assigned to a router in a shared network", - "length": 255, - "name": "routerip", - "required": false, - "since": "4.16", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "the display text of the network", - "length": 255, - "name": "displaytext", - "required": false, + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": "ID of the network in an external system.", - "length": 255, - "name": "externalid", - "required": false, + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the ID or VID of the network", - "length": 255, - "name": "vlan", - "required": false, + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { - "description": "the network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "the second IPv4 DNS for the network", - "length": 255, - "name": "dns2", - "required": false, - "since": "4.18.0", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "length": 255, - "name": "tungstenvirtualrouteruuid", - "required": false, + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", - "length": 255, - "name": "publicmtu", - "required": false, - "since": "4.18.0", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", - "length": 255, - "name": "ip6gateway", - "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", - "required": false, - "type": "string" - }, - { - "description": "domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "an optional field, whether to the display the network to the end user or not.", - "length": 255, - "name": "displaynetwork", - "required": false, + "description": "is vpn for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the first IPv6 DNS for the network", - "length": 255, - "name": "ip6dns1", - "required": false, - "since": "4.18.0", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "Network ACL ID associated for the network", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList", - "required": false, - "type": "uuid" - }, - { - "description": "the first IPv4 DNS for the network", - "length": 255, - "name": "dns1", - "required": false, - "since": "4.18.0", + "description": "the state of the rule", + "name": "state", "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 network this network is associated to. only available if create a Shared network", - "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "since": "4.17.0", - "type": "uuid" - }, - { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", - "length": 255, - "name": "endip", - "required": false, + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, + {}, { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, + "description": "the project name of the vpn", + "name": "project", "type": "string" - }, - { - "description": "the physical network ID the network belongs to", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, - "type": "uuid" - }, + } + ] + }, + { + "description": "(This API is deprecated, use scaleVirtualMachine API)Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for this command to take effect.", + "isasync": false, + "name": "changeServiceForVirtualMachine", + "params": [ { - "description": "the name of the network", + "description": "The ID of the virtual machine", "length": 255, - "name": "name", + "name": "id", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "IPV6 address to be assigned to a router in a shared network", + "description": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "routeripv6", + "name": "miniops", "required": false, - "since": "4.16", - "type": "string" + "since": "4.17", + "type": "long" }, { - "description": "the VPC network belongs to", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "maxiops", "required": false, - "type": "uuid" + "since": "4.17", + "type": "long" }, { - "description": "the zone ID for the network", + "description": "the service offering ID to apply to the virtual machine", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "network domain", - "length": 255, - "name": "networkdomain", - "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 isolated private VLAN type for this network", - "length": 255, - "name": "isolatedpvlantype", - "required": false, - "type": "string" - }, - { - "description": "Account that will own the network. Account should be under the selected domain", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified", + "description": "Verify OK to Shrink", "length": 255, - "name": "subdomainaccess", + "name": "shrinkok", "required": false, + "since": "4.17", "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": "the beginning IPv6 address in the IPv6 network range", - "length": 255, - "name": "startipv6", - "required": false, - "type": "string" - }, - { - "description": "the second IPv6 DNS for the network", - "length": 255, - "name": "ip6dns2", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "MTU to be configured on the network VR's private interface(s)", - "length": 255, - "name": "privatemtu", - "required": false, - "since": "4.18.0", - "type": "integer" - }, - { - "description": "an optional project for the network", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", - "required": false, - "type": "uuid" - }, - { - "description": "the isolated private VLAN for this network", - "length": 255, - "name": "isolatedpvlan", - "required": false, - "type": "string" - }, - { - "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", "length": 255, - "name": "sourcenatipaddress", + "name": "details", "required": false, - "since": "4.19", - "type": "string" + "type": "map" }, { - "description": "the beginning IP address in the network IP range", + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, - "name": "startip", + "name": "automigrate", "required": false, - "type": "string" + "since": "4.17", + "type": "boolean" } ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "response": [ { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the 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 egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the 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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "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 name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + } + ], "type": "set" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of the network", - "name": "name", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { "description": "true if the entity/resource has annotations", @@ -89056,163 +83620,57 @@ "type": "boolean" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "zone id of the network", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" - }, - { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the id of the network", - "name": "id", + "description": "device type of the root volume", + "name": "rootdevicetype", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the list of resource tags associated with network", + "description": "the list of resource tags associated", "name": "tags", "response": [ { @@ -89220,6 +83678,16 @@ "name": "account", "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", @@ -89230,638 +83698,770 @@ "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", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" } ], - "type": "list" - }, - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" - }, - { - "description": "The external id of the network", - "name": "externalid", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "type": "set" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "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 routes for the network to ease adding route in upstream router", - "name": "ip6routes", + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the 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 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": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the 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": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + } + ], "type": "set" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the 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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, - {}, { - "description": "the project name of the address", - "name": "project", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, - {}, { - "description": "the network domain", - "name": "networkdomain", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } - ] - }, - { - "description": "Lists all available network offerings.", - "isasync": false, - "name": "listNetworkOfferings", - "params": [ + }, { - "description": "list by traffic type", - "length": 255, - "name": "traffictype", - "required": false, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", - "length": 255, - "name": "sourcenatsupported", - "required": false, - "type": "boolean" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, + {}, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "list network offerings by state", - "length": 255, + "description": "the state of the virtual machine", "name": "state", - "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "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", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "list network offerings by guest type: shared or isolated", - "length": 255, - "name": "guestiptype", - "required": false, + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "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": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "true if offering has tags specified", - "length": 255, - "name": "istagged", - "required": false, - "type": "boolean" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", - "required": false, + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "list network offerings by display text", - "length": 255, - "name": "displaytext", - "required": false, + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "list network offerings by ID", - "length": 255, - "name": "id", - "related": "listNetworkOfferings", - "required": false, - "type": "uuid" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the network offering can be used only for network creation inside the VPC", - "length": 255, - "name": "forvpc", - "required": false, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "list network offerings by name", - "length": 255, - "name": "name", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "list network offerings supporting certain services", - "length": 255, - "name": "supportedservices", - "required": false, + "description": "NICs of the VNF appliance", + "name": "vnfnics", "type": "list" }, { - "description": "the availability of network offering. Default value is required", - "length": 255, - "name": "availability", - "required": false, + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if need to list only network offerings which support specifying ip ranges", - "length": 255, - "name": "specifyipranges", - "required": false, - "type": "boolean" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the tags for the network offering.", - "length": 255, - "name": "specifyvlan", - "required": false, - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "true if need to list only default network offerings. Default value is false", - "length": 255, - "name": "isdefault", - "required": false, - "type": "boolean" - } - ], - "related": "", - "response": [ + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "true if network offering supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", - "type": "boolean" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, + {} + ] + }, + { + "description": "Lists all available OS mappings for given hypervisor", + "isasync": false, + "name": "listGuestOsMapping", + "params": [ { - "description": "the id of the network offering", + "description": "list mapping by its UUID", + "length": 255, "name": "id", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", + "required": false, + "type": "uuid" + }, + { + "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", + "length": 255, + "name": "hypervisorversion", + "required": false, "type": "string" }, { - "description": "the name of the network offering", - "name": "name", + "description": "list Guest OS mapping by OS mapping name with hypervisor", + "length": 255, + "name": "osnameforhypervisor", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "list Guest OS mapping by hypervisor", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list Guest OS mapping by OS display name", + "length": 255, + "name": "osdisplayname", + "required": false, "type": "string" }, - {}, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "list mapping by Guest OS Type UUID", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, - {}, + } + ], + "related": "addGuestOsMapping,updateGuestOsMapping", + "response": [ { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", + "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" + "description": "the ID of the Guest OS mapping", + "name": "id", + "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, { - "description": "the tags for the network offering", - "name": "tags", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "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 domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hypervisor", + "name": "hypervisor", + "type": "string" + } + ], + "since": "4.4.0" + }, + { + "description": "List all public, private, and privileged templates.", + "isasync": false, + "name": "listTemplates", + "params": [ + { + "description": "the template ID", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "ID of the image or image cache store", + "length": 255, + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": false, + "since": "4.19", + "type": "uuid" }, { - "description": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "length": 255, + "name": "isvnf", + "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "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": "Lists dedicated pods.", - "isasync": false, - "name": "listDedicatedPods", - "params": [ + }, { "description": "", "length": 255, @@ -89870,937 +84470,379 @@ "type": "integer" }, { - "description": "the ID of the domain associated with the pod", + "description": "list only resources belonging to the domain specified", "length": 255, "name": "domainid", - "related": "listDomainChildren,listDomains", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "", + "description": "the type of the template", "length": 255, - "name": "pagesize", + "name": "templatetype", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "string" }, { - "description": "the ID of the pod", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "List by keyword", + "description": "comma separated list of template details requested, value can be a list of [ all, min]", "length": 255, - "name": "keyword", + "name": "details", "required": false, - "type": "string" + "since": "4.15", + "type": "list" }, { - "description": "list dedicated pods by affinity group", + "description": "", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the account associated with the pod. Must be used with domainId.", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "account", + "name": "parenttemplateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", - "type": "string" + "since": "4.4", + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "show removed templates as well", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" }, { - "description": "the Name of the Pod", - "name": "podname", - "type": "string" + "description": "ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.19", + "type": "uuid" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the ID of the Pod", - "name": "podid", - "type": "string" + "description": "list templates by zoneId", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", - "type": "string" + "description": "flag to display the resource image for the templates", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, - {}, - {}, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Attempts Migration of a VM with its volumes to a different host", - "isasync": true, - "name": "migrateVirtualMachineWithVolume", - "params": [ { - "description": "Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=&migrateto[volume-index].pool=Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume= indicates the UUID of the volume that you want to migrate, and pool= indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "migrateto", + "name": "ids", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "type": "map" + "since": "4.9", + "type": "list" }, { - "description": "Destination Host ID to migrate VM to.", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "showunique", "required": false, - "type": "uuid" + "since": "4.13.2", + "type": "boolean" }, { - "description": "the ID of the virtual machine", + "description": "the template name", "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { - "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "autoselect", + "name": "arch", "required": false, - "since": "4.19.0", - "type": "boolean" + "since": "4.20", + "type": "string" } ], - "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,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "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": "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "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 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": "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" - } - ], - "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 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": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - {}, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the size of the template", + "name": "size", "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the name of userdata linked to this template", + "name": "userdataname", "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 project name of the vm", + "description": "the project name of the template", "name": "project", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Vm details in key/value pairs.", + "description": "additional key/value details tied with template", "name": "details", "type": "map" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "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 date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "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 backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, - {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the 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 the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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": "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 Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "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 vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - } - ], - "type": "set" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the template ID", + "name": "id", "type": "string" }, + {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "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 VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the template name", + "name": "name", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "tag key name", "name": "key", @@ -90812,522 +84854,284 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the name of the affinity group", - "name": "name", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name where tag belongs to", + "name": "project", "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": "the project ID of the affinity group", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain ID of the affinity group", + "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" } ], "type": "set" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "the ID of the 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 this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "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 processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "checksum of the template", + "name": "checksum", "type": "string" - }, + } + ] + }, + { + "description": "create Tungsten-Fabric policy", + "isasync": true, + "name": "createTungstenFabricPolicy", + "params": [ { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Tungsten-Fabric policy name", + "length": 255, + "name": "name", + "required": true, "type": "string" - }, + } + ], + "related": "listTungstenFabricPolicy", + "response": [ { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, + {}, { - "description": "the name of the virtual machine", + "description": "Tungsten-Fabric policy name", "name": "name", "type": "string" }, + {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, + {}, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "deletes a range of Autonomous Systems for BGP Dynamic Routing", + "isasync": false, + "name": "deleteASNRange", + "params": [ { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, + "description": "ID of the AS range", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ] + ], + "since": "4.20.0" }, { - "description": "Lists VPCs", - "isasync": false, - "name": "listVPCs", + "description": "Creates a bucket in the specified object storage pool. ", + "isasync": true, + "name": "createBucket", "params": [ { - "description": "List by display text of the VPC", + "description": "Enable object locking in bucket", "length": 255, - "name": "displaytext", + "name": "objectlocking", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "Bucket Quota in GB", "length": 255, - "name": "keyword", + "name": "quota", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list VPCs by state", + "description": "Id of the Object Storage Pool where bucket is created", "length": 255, - "name": "state", - "required": false, + "name": "objectstorageid", + "related": "addObjectStoragePool", + "required": true, + "type": "uuid" + }, + { + "description": "the name of the bucket", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "flag to display the resource icon for VPCs", + "description": "Enable bucket versioning", "length": 255, - "name": "showicon", + "name": "versioning", "required": false, "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the account associated with the bucket. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject,updateProject", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list VPC by id", + "description": "Enable bucket encryption", "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "encryption", "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 cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", - "length": 255, - "name": "cidr", - "required": false, - "type": "string" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain.", "length": 255, "name": "domainid", - "related": "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 ID of the VPC offering", - "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "list by zone", + "description": "the project associated with the bucket. Mutually exclusive with account parameter", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "list VPC supporting certain services", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list by name of the VPC", + "description": "The Bucket access policy", "length": 255, - "name": "name", + "name": "policy", "required": false, "type": "string" - }, - { - "description": "list VPCs by restartRequired option", - "length": 255, - "name": "restartrequired", - "required": false, - "type": "boolean" } ], - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "related": "listBuckets", "response": [ { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "the capability value", - "name": "value", - "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "the owner of the VPC", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "the id of the VPC", - "name": "id", - "type": "string" - }, - { - "description": "the name of the VPC", - "name": "name", - "type": "string" - }, - { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -91335,93 +85139,87 @@ "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" - }, - { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "ID of the Bucket", + "name": "id", "type": "string" }, - {}, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "the domain associated with the bucket", + "name": "domain", "type": "string" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "Object storage provider", + "name": "provider", "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "Bucket Access Key", + "name": "accesskey", "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "Bucket Secret Key", + "name": "usersecretkey", "type": "string" }, { - "description": "state of the VPC. Can be Inactive/Enabled", + "description": "State of the Bucket", "name": "state", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "Bucket Access Policy", + "name": "policy", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "name of the Bucket", + "name": "name", + "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of resource tags associated with the project", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -91430,13 +85228,18 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -91445,136 +85248,168 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "Bucket Encryption", + "name": "encryption", "type": "boolean" }, + {}, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ID of the domain associated with the bucket", + "name": "domainid", + "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "the project id of the bucket", + "name": "projectid", + "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "Bucket URL", + "name": "url", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the project name of the bucket", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ] - }, - { - "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", - "isasync": false, - "name": "addNetworkDevice", - "params": [ - { - "description": "parameters for network device", - "length": 255, - "name": "networkdeviceparameterlist", - "required": false, - "type": "map" + "description": "the date the Bucket was created", + "name": "created", + "type": "date" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", - "length": 255, - "name": "networkdevicetype", - "required": false, + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", "type": "string" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Bucket Quota in GB", + "name": "quota", "type": "integer" }, { - "description": "the ID of the network device", - "name": "id", + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" + }, + { + "description": "the account associated with the Bucket", + "name": "account", "type": "string" } - ] + ], + "since": "4.19.0" }, { - "description": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", - "isasync": true, - "name": "runDiagnostics", + "description": "Lists physical networks", + "isasync": false, + "name": "listPhysicalNetworks", "params": [ { - "description": "The IP/Domain address to test connection to", + "description": "search by name", "length": 255, - "name": "ipaddress", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "Additional command line options that apply for each command", + "description": "", "length": 255, - "name": "params", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The ID of the system VM instance to diagnose", + "description": "the Zone ID for the physical network", "length": 255, - "name": "targetid", - "related": "migrateSystemVm,startSystemVm", - "required": true, + "name": "zoneid", + "related": "listZones", + "required": false, "type": "uuid" }, { - "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", + "description": "list physical network by id", "length": 255, - "name": "type", - "required": true, + "name": "id", + "related": "listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "", + "related": "updatePhysicalNetwork", "response": [ { - "description": "the standard output from the command execution", - "name": "stdout", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "the command execution return code", - "name": "exitcode", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of the physical network", + "name": "zoneid", + "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": "the vlan of the physical network", + "name": "vlan", + "type": "string" + }, + { + "description": "the domain id of the physical network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { @@ -91582,278 +85417,295 @@ "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "the standard error output from the command execution", - "name": "stderr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + { + "description": "name of the physical network", + "name": "name", + "type": "string" + }, + { + "description": "zone name of the physical network", + "name": "zonename", + "type": "string" + }, + {} ], - "since": "4.12.0.0" + "since": "3.0.0" }, { - "description": "Updates a user account", + "description": "Lists all firewall rules for an IP address.", "isasync": false, - "name": "updateUser", + "name": "listFirewallRules", "params": [ { - "description": "Unique username", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "username", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "last name", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "lastname", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The secret key for the user. Must be specified with userApiKey", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "usersecretkey", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "first name", + "description": "", "length": 255, - "name": "firstname", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The API key for the user. Must be specified with userSecretKey", + "description": "Lists rule with the specified ID.", "length": 255, - "name": "userapikey", + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA", + "description": "", "length": 255, - "name": "mandate2fa", + "name": "pagesize", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "type": "integer" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "timezone", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "email", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "email", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "User uuid", + "description": "list firewall rules for certain network", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,updateUser", - "required": true, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "since": "4.3", "type": "uuid" }, { - "description": "Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port", + "description": "List by keyword", "length": 255, - "name": "password", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Current password that was being used by the user. You must inform the current password when updating the password.", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "currentpassword", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "string" - } - ], - "related": "createUser,disableUser,enableUser,getUser,listUsers", - "response": [ - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "type": "uuid" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "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 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 domain ID of the user", - "name": "domainid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, + } + ], + "related": "createFirewallRule,updateEgressFirewallRule", + "response": [ { - "description": "the ID of the role", - "name": "roleid", + "description": "the ID of the firewall rule", + "name": "id", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the user lastname", - "name": "lastname", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the user state", - "name": "state", + "description": "the network id of the firewall rule", + "name": "networkid", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "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 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" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" }, + {}, { - "description": "the user name", - "name": "username", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, {}, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the state of the rule", + "name": "state", "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" } ] }, { - "description": "Restarts a VPC", + "description": " delete a Brocade VCS Switch", "isasync": true, - "name": "restartVPC", + "name": "deleteBrocadeVcsDevice", "params": [ { - "description": "If cleanup old network elements", - "length": 255, - "name": "cleanup", - "required": false, - "type": "boolean" - }, - { - "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", - "length": 255, - "name": "livepatch", - "required": false, - "since": "4.17.0", - "type": "boolean" - }, - { - "description": "Turn a single VPC into a redundant one.", - "length": 255, - "name": "makeredundant", - "required": false, - "type": "boolean" - }, - { - "description": "the id of the VPC", + "description": "Brocade Switch ID", "length": 255, - "name": "id", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "name": "vcsdeviceid", + "related": "", "required": true, "type": "uuid" } ], "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, @@ -91863,1603 +85715,1235 @@ "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { - "description": "Removes a certificate from a load balancer rule", - "isasync": true, - "name": "removeCertFromLoadBalancer", + "description": "Lists all Routing firewall rules", + "isasync": false, + "name": "listRoutingFirewallRules", "params": [ { - "description": "the ID of the load balancer rule", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": true, + "name": "projectid", + "related": "createProject", + "required": false, "type": "uuid" - } - ], - "response": [ - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Adds a new host.", - "isasync": false, - "name": "addHost", - "params": [ - { - "description": "hypervisor type of the host", + "description": "", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the cluster name for the host", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "clustername", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "the cluster ID for the host", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the host URL", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "url", - "required": true, - "type": "string" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "list of tags to be added to the host", + "description": "list Routing firewall rules by traffic type - ingress or egress", "length": 255, - "name": "hosttags", + "name": "traffictype", "required": false, - "type": "list" + "type": "string" }, { - "description": "the Pod ID for the host", + "description": "list Routing firewall rules by network ID", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, "type": "uuid" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "password", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "username", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "allocationstate", + "name": "fordisplay", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the Zone ID for the host", + "description": "Lists Routing firewall rule with the specified ID", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "name": "id", + "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "required": false, "type": "uuid" } ], - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "response": [ { - "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 host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" - }, - { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, + {}, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "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": "events available for the host", - "name": "events", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" - }, - {}, - { - "description": "the host version", - "name": "version", - "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the 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" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" }, - {}, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the state of the rule", + "name": "state", "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 used", - "name": "cpuused", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the ID of the host", - "name": "id", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.20.0" + }, + { + "description": "Extracts an ISO", + "isasync": true, + "name": "extractIso", + "params": [ { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the URL to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the ID of the ISO file", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "the Zone ID of the host", + "description": "the ID of the zone where the ISO is originally located", + "length": 255, "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "extractSnapshot,extractTemplate,downloadImageStoreObject", + "response": [ + { + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", - "response": [ - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - }, - { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "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": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "", + "name": "resultstring", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the state of the extracted object", + "name": "state", + "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "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": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "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 number of CPU sockets on the host", - "name": "cpusockets", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", "type": "integer" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "type of the storage", + "name": "storagetype", + "type": "string" }, + {}, { - "description": "the Zone name of the host", + "description": "zone name the object was extracted from", "name": "zonename", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the account id to which the extracted object belongs", + "name": "accountid", + "type": "string" } ] }, { - "description": "Attaches a disk volume to a virtual machine.", + "description": "Creates an affinity/anti-affinity group", "isasync": true, - "name": "attachVolume", + "name": "createAffinityGroup", "params": [ { - "description": "the ID of the disk volume", + "description": "an account for the affinity group. Must be used with domainId.", "length": 255, - "name": "id", - "related": "attachVolume,createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { - "description": "The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.
When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:
  • 0 maps to /dev/xvda;
  • 1 maps to /dev/xvdb;
  • 2 maps /dev/xvdc and so on.
Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.", + "description": "domainId of the account owning the affinity group", "length": 255, - "name": "deviceid", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "long" + "type": "uuid" }, { - "description": " the ID of the virtual machine", + "description": "optional description of the affinity group", "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "createVolume,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", + "name": "description", + "required": false, "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "create affinity group for project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "name of the disk volume", + "description": "name of the affinity group", + "length": 255, "name": "name", + "required": true, "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, + {}, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, + {} + ] + }, + { + "description": "Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the \"logout\" command has been issued or the session has expired.", + "isasync": false, + "name": "oauthlogin", + "params": [ { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "length": 255, + "name": "secretcode", + "required": false, "type": "string" }, - {}, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "Name of the provider", + "length": 255, + "name": "provider", + "required": true, + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "Email id with which user tried to login using OAuth provider", + "length": 255, + "name": "email", + "required": true, "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "The id of the domain that the user belongs to. If both domain and domainId are passed in, \"domainId\" parameter takes precedence.", + "length": 255, + "name": "domainId", + "required": false, + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.", + "length": 255, + "name": "domain", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "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": "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "Username", + "name": "username", "type": "string" }, + {}, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "last name of the user", + "name": "lastname", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "User ID", + "name": "userid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "Is two factor authentication verified", + "name": "is2faverified", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "pod name of the volume", - "name": "podname", + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "Is user registered", + "name": "registered", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "user time zoneoffset", + "name": "timezoneoffset", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "user time zone", + "name": "timezone", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "first name of the user", + "name": "firstname", "type": "string" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Lists all available Internal Load Balancer elements.", + "isasync": false, + "name": "listInternalLoadBalancerElements", + "params": [ { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "list internal load balancer elements by enabled state", + "length": 255, + "name": "enabled", + "required": false, + "type": "boolean" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "list internal load balancer elements by id", + "length": 255, + "name": "id", + "related": "listInternalLoadBalancerElements", + "required": false, + "type": "uuid" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, + "description": "list internal load balancer elements by network service provider id", + "length": 255, + "name": "nspid", + "related": "addNetworkServiceProvider,listTrafficTypes", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "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": "the physical network service provider id of the element", + "name": "nspid", + "type": "string" }, + {}, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "Enabled/Disabled the element", + "name": "enabled", "type": "boolean" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Gets the guest OS names in the hypervisor", + "isasync": true, + "name": "getHypervisorGuestOsNames", + "params": [ { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "Hypervisor version to get the guest os names (atleast one hypervisor host with the version specified must be available)", + "length": 255, + "name": "hypervisorversion", + "required": true, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "ID of the disk volume", - "name": "id", + "description": "Hypervisor type. One of : VMware, XenServer", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, + "description": "Keyword for guest os name", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ { - "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": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "version of the hypervisor for guest os names", + "name": "hypervisorversion", + "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "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": "the guest OS count of the hypervisor", + "name": "guestoscount", + "type": "integer" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "the guest OS list of the hypervisor", + "name": "guestoslist", + "response": [ + { + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", + "type": "string" + }, + { + "description": "standard display name for the Guest OS", + "name": "osdisplayname", + "type": "string" + } + ], + "type": "list" } - ] + ], + "since": "4.19.0" }, { - "description": "adds a baremetal dhcp server", - "isasync": true, - "name": "addBaremetalDhcp", + "description": "Create Tungsten-Fabric provider in cloudstack", + "isasync": false, + "name": "createTungstenFabricProvider", "params": [ { - "description": "the Physical Network ID", + "description": "Tungsten-Fabric provider vrouter port", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "name": "tungstenprovidervrouterport", + "required": false, + "type": "string" }, { - "description": "Credentials to reach external dhcp device", + "description": "Tungsten-Fabric provider gateway", "length": 255, - "name": "password", + "name": "tungstengateway", "required": true, "type": "string" }, { - "description": "Type of dhcp device", + "description": "Tungsten-Fabric provider port", "length": 255, - "name": "dhcpservertype", + "name": "tungstenproviderport", + "required": false, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider hostname", + "length": 255, + "name": "tungstenproviderhostname", "required": true, "type": "string" }, { - "description": "Credentials to reach external dhcp device", + "description": "Tungsten-Fabric provider name", "length": 255, - "name": "username", + "name": "name", "required": true, "type": "string" }, { - "description": "URL of the external dhcp appliance.", + "description": "the ID of zone", "length": 255, - "name": "url", + "name": "zoneid", + "related": "listZones", "required": true, + "type": "uuid" + }, + { + "description": "Tungsten-Fabric provider introspect port", + "length": 255, + "name": "tungstenproviderintrospectport", + "required": false, "type": "string" } ], - "related": "listBaremetalDhcp", + "related": "", "response": [ { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "type": "string" }, + {}, { - "description": "name of the provider", - "name": "dhcpservertype", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "url", - "name": "url", + "description": "Tungsten-Fabric provider name", + "name": "name", "type": "string" }, { - "description": "device id of ", - "name": "id", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, - {}, - {} - ] - }, - { - "description": "delete Tungsten-Fabric application policy set", - "isasync": true, - "name": "deleteTungstenFabricApplicationPolicySet", - "params": [ { - "description": "the uuid of Tungsten-Fabric application policy set", - "length": 255, - "name": "applicationpolicysetuuid", - "required": true, + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "type": "string" - }, - {} + } ] }, { - "description": "Copies a snapshot from one zone to another.", + "description": "Reboots a virtual machine.", "isasync": true, - "name": "copySnapshot", + "name": "rebootVirtualMachine", "params": [ { - "description": "A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", - "length": 255, - "name": "destzoneids", - "related": "createZone,listZones,listZones", - "required": false, - "type": "list" - }, - { - "description": "The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used.", + "description": "The ID of the virtual machine", "length": 255, - "name": "sourcezoneid", - "related": "createZone,listZones,listZones", - "required": false, + "name": "id", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, "type": "uuid" }, { - "description": "the ID of the snapshot.", + "description": "Boot into hardware setup menu or not", "length": 255, - "name": "id", - "related": "copySnapshot,revertSnapshot,listSnapshots", - "required": true, - "type": "uuid" + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "The ID of the zone the snapshot is being copied to.", + "description": "Force reboot the VM (VM is Stopped and then Started)", "length": 255, - "name": "destzoneid", - "related": "createZone,listZones,listZones", + "name": "forced", "required": false, - "type": "uuid" + "since": "4.16.0", + "type": "boolean" } ], - "related": "revertSnapshot,listSnapshots", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "response": [ { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {}, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, - {}, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "ID of the snapshot", - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "the domain name of the snapshot's account", - "name": "domain", - "type": "string" - }, - { - "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", - "name": "state", - "type": "state" - }, - { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" - }, - { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - } - ], - "since": "4.19.0" - }, - { - "description": "Adds Traffic Monitor Host for Direct Network Usage", - "isasync": false, - "name": "addTrafficMonitor", - "params": [ - { - "description": "Traffic going into the listed zones will be metered", - "length": 255, - "name": "includezones", - "required": false, - "type": "string" - }, - { - "description": "Zone in which to add the external firewall appliance.", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" - }, - { - "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 number of times to retry requests to the external firewall", - "name": "numretries", - "type": "string" - }, - {}, - { - "description": "the ID of the external firewall", - "name": "id", - "type": "string" - }, - { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" - }, - { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - {} - ] - }, - { - "description": "Updates a project", - "isasync": true, - "name": "updateProject", - "params": [ { - "description": "when true, it swaps ownership with the account/ user provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true", - "length": 255, - "name": "swapowner", - "required": false, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "new Admin account for the project", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "display text of the project", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "ID of the user to be promoted/demoted", - "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers", - "required": false, - "type": "uuid" - }, - { - "description": "id of the project to be modified", - "length": 255, - "name": "id", - "related": "activateProject,suspendProject,updateProject", - "required": true, - "type": "uuid" - }, - { - "description": "name of the project", - "length": 255, - "name": "name", - "required": false, - "since": "4.19.0", - "type": "string" - }, - { - "description": "Account level role to be assigned to the user/account : Admin/Regular", - "length": 255, - "name": "roletype", - "required": false, - "type": "string" - } - ], - "related": "activateProject,suspendProject", - "response": [ - { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" - }, - { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the id of the project", - "name": "id", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" - }, - {}, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - {}, - { - "description": "the total 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 number of vpcs the project can own", - "name": "vpclimit", - "type": "string" - }, - { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the state of the project", - "name": "state", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", - "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 with vm", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -93473,18 +86957,18 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -93493,687 +86977,831 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the 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" } ], - "type": "list" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" + "type": "set" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, + {}, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "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", + "description": "the name of the domain in which the virtual machine exists", "name": "domain", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Lists internal load balancers", - "isasync": false, - "name": "listLoadBalancers", - "params": [ - { - "description": "the network ID of the source IP address", - "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "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": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "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": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the source IP address of the load balancer", - "length": 255, - "name": "sourceipaddress", - "required": false, + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the load balancer", - "length": 255, - "name": "name", - "required": false, + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the load balancer", - "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule", - "required": false, - "type": "uuid" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the scheme of the load balancer. Supported value is internal in the current release", - "length": 255, - "name": "scheme", - "required": false, - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the network ID of the load balancer", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - } - ], - "related": "createLoadBalancer", - "response": [ - { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, - {}, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the description of the Load Balancer", - "name": "description", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "instance port of the load balancer rule", - "name": "instanceport", - "type": "integer" + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" }, { - "description": "source port of the load balancer rule", - "name": "sourceport", - "type": "integer" + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "the state of the load balancer rule", - "name": "state", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" - } - ], - "type": "list" - }, - {}, - { - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the list of instances associated with the Load Balancer", - "name": "loadbalancerinstance", - "response": [ + }, { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the state of the instance", - "name": "state", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the instance ID", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the name of the instance", - "name": "name", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" - } - ], - "type": "list" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the name of the Load Balancer", - "name": "name", - "type": "string" - }, - { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "description": "the domain of the Load Balancer", - "name": "domain", - "type": "string" - }, - { - "description": "the Load Balancer ID", - "name": "id", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", - "response": [ + }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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": "customer associated with the tag", - "name": "customer", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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 resource", - "name": "resourceid", + "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" } ], - "type": "list" - } - ], - "since": "4.2.0" - }, - { - "description": "Lists user accounts", - "isasync": false, - "name": "listUsers", - "params": [ - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "List user by the username", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "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": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "type": "set" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, + {}, { - "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", - "length": 255, - "name": "accounttype", - "required": false, - "type": "integer" - }, - { - "description": "List users by state of the user account.", - "length": 255, - "name": "state", - "required": false, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "flag to display the resource icon for users", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - } - ], - "related": "createUser,disableUser,enableUser,getUser", - "response": [ - { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the 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 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 list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "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": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + } + ], + "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "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 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": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the domain name of the user", - "name": "domain", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the user firstname", - "name": "firstname", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the user state", - "name": "state", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, - {}, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the user ID", - "name": "id", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - {}, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" } ] }, { - "description": "This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user", - "isasync": false, - "name": "registerUserKeys", + "description": "Enables HA cluster-wide", + "isasync": true, + "name": "enableHAForCluster", "params": [ { - "description": "User id", + "description": "ID of the cluster", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": true, "type": "uuid" } ], - "related": "", "response": [ - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { - "description": "the secret key of the registered user", - "name": "secretkey", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -94181,277 +87809,283 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the api key of the registered user", - "name": "apikey", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } - ] + ], + "since": "4.11" }, { - "description": "Deletes a load balancer stickiness policy.", - "isasync": true, - "name": "deleteLBStickinessPolicy", + "description": "Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.", + "isasync": false, + "name": "addVirtualMachinesToKubernetesCluster", "params": [ { - "description": "the ID of the LB stickiness policy", + "description": "the IDs of the VMs to add to the cluster", + "length": 255, + "name": "virtualmachineids", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "list" + }, + { + "description": "the ID of the Kubernetes cluster", "length": 255, "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", "required": true, "type": "uuid" + }, + { + "description": "Is control node or not? Defaults to false.", + "length": 255, + "name": "iscontrolnode", + "required": false, + "type": "boolean" } ], "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" } ], - "since": "3.0.0" + "since": "4.19.0" }, { - "description": "Updates a VLAN IP range.", + "description": "list Tungsten-Fabric logical router", "isasync": false, - "name": "updateVlanIpRange", + "name": "listTungstenFabricLogicalRouter", "params": [ { - "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", + "description": "", "length": 255, - "name": "ip6cidr", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "", "length": 255, - "name": "forsystemvms", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the gateway of the VLAN IP range", + "description": "List by keyword", "length": 255, - "name": "gateway", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the netmask of the VLAN IP range", + "description": "the ID of zone", "length": 255, - "name": "netmask", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" - }, - { - "description": "the UUID of the VLAN IP range", - "length": 255, - "name": "id", - "related": "updateVlanIpRange,dedicatePublicIpRange", - "required": true, "type": "uuid" }, { - "description": "the beginning IP address in the VLAN IP range", - "length": 255, - "name": "startip", - "required": false, - "type": "string" - }, - { - "description": "the ending IPv6 address in the IPv6 network range", - "length": 255, - "name": "endipv6", - "required": false, - "type": "string" - }, - { - "description": "the ending IP address in the VLAN IP range", + "description": "the uuid of Tungsten-Fabric network", "length": 255, - "name": "endip", + "name": "networkuuid", "required": false, "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the uuid of Tungsten-Fabric logical router", "length": 255, - "name": "startipv6", + "name": "logicalrouteruuid", "required": false, "type": "string" } ], - "related": "dedicatePublicIpRange", + "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" - }, - { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "Tungsten-Fabric logical router name", + "name": "name", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, + {}, + {}, { - "description": "the Zone ID of the VLAN IP range", + "description": "Tungsten-Fabric provider zone id", "name": "zoneid", - "type": "string" - }, - { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "type": "long" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "type": "string" + } + ] + }, + { + "description": "Adds a guest OS name to hypervisor OS name mapping", + "isasync": true, + "name": "addGuestOsMapping", + "params": [ + { + "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", + "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", + "length": 255, + "name": "osmappingcheckenabled", + "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", - "type": "string" + "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", + "length": 255, + "name": "forced", + "required": false, + "since": "4.19.0", + "type": "boolean" }, - {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "Hypervisor type. One of : XenServer, KVM, VMWare", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version", + "length": 255, + "name": "hypervisorversion", + "required": true, "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "OS name specific to the hypervisor", + "length": 255, + "name": "osnameforhypervisor", + "required": true, "type": "string" - }, + } + ], + "related": "updateGuestOsMapping", + "response": [ { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, + {}, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" - }, - { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "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" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" } ], - "since": "4.16.0" + "since": "4.4.0" }, { - "description": "Lists site to site vpn connection gateways", + "description": "List all public, private, and privileged VNF templates.", "isasync": false, - "name": "listVpnConnections", + "name": "listVnfTemplates", "params": [ + { + "description": "If set to true, list only unique templates across zones", + "length": 255, + "name": "showunique", + "required": false, + "since": "4.13.2", + "type": "boolean" + }, { "description": "List by keyword", "length": 255, @@ -94459,6 +88093,14 @@ "required": false, "type": "string" }, + { + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, { "description": "", "length": 255, @@ -94467,21 +88109,29 @@ "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "the template ID", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, { - "description": "id of the vpn connection", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections", + "name": "parenttemplateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, + "since": "4.4", "type": "uuid" }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, { "description": "", "length": 255, @@ -94490,1662 +88140,2154 @@ "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "isrecursive", + "name": "hypervisor", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "show removed templates as well", "length": 255, - "name": "listall", + "name": "showremoved", "required": false, "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "fordisplay", + "name": "ids", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "id of vpc", + "description": "the template name", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", + "name": "name", "required": false, - "type": "uuid" - } - ], - "related": "createVpnConnection", - "response": [ + "type": "string" + }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "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": "IKE policy of the customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "length": 255, + "name": "details", + "required": false, + "since": "4.15", + "type": "list" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "length": 255, + "name": "isvnf", + "required": false, + "since": "4.19.0", + "type": "boolean" }, { - "description": "the project name", - "name": "project", - "type": "string" + "description": "list templates by zoneId", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "State of vpn connection", - "name": "state", + "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": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the template", + "length": 255, + "name": "templatetype", + "required": false, + "since": "4.19.0", + "type": "string" }, { - "description": "State of vpn connection", - "name": "passive", + "description": "flag to display the resource image for the templates", + "length": 255, + "name": "showicon", + "required": false, "type": "boolean" }, { - "description": "the owner", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "the account name to which the template belongs", "name": "account", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, - {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", - "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": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" - } - ] - }, - { - "description": "Lists resource limits.", - "isasync": false, - "name": "listResourceLimits", - "params": [ - { - "description": "Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetypename", - "required": false, + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the 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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag 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 URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Lists resource limits by ID.", - "length": 255, - "name": "id", - "required": false, - "type": "long" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of snapshots an account can own. 4 - Template. Number of templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", - "length": 255, - "name": "resourcetype", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - {}, + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, { - "description": "the domain ID of the resource limit", - "name": "domainid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", + "description": "the size of the template", + "name": "size", "type": "long" }, { - "description": "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.", - "name": "resourcetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "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 project id of the resource limit", - "name": "projectid", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" }, {}, { - "description": "the account of the resource limit", - "name": "account", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the project name of the resource limit", - "name": "project", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" - } - ] - }, - { - "description": "Disables a user account", - "isasync": true, - "name": "disableUser", - "params": [ - { - "description": "Disables user by user ID.", - "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser", - "required": true, - "type": "uuid" - } - ], - "related": "createUser,enableUser,getUser", - "response": [ + }, { - "description": "the date and time the user account was created", + "description": "the date this template was created", "name": "created", "type": "date" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "the user ID", - "name": "id", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, - {}, { - "description": "the user state", - "name": "state", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the type of the role", - "name": "roletype", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + } + ], + "since": "4.19.0" + }, + { + "description": "Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.", + "isasync": true, + "name": "deployVnfAppliance", + "params": [ { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the ipv6 address for default vm's network", + "length": 255, + "name": "ip6address", + "required": false, "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "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 hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "length": 255, + "name": "copyimagetags", + "required": false, + "since": "4.13", "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", - "type": "string" + "description": "names of the ssh key pairs used to login to the virtual machine", + "length": 255, + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", + "length": 255, + "name": "overridediskofferingid", + "related": "", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, "type": "string" }, - {}, { - "description": "the ID of the role", - "name": "roleid", + "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "length": 255, + "name": "boottype", + "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0.", + "length": 255, + "name": "vnfcidrlist", + "required": false, + "type": "list" }, { - "description": "the user email address", - "name": "email", + "description": "name of the ssh key pair used to login to the virtual machine", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "type": "string" + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "remove Tungsten-Fabric policy", - "isasync": true, - "name": "removeTungstenFabricPolicy", - "params": [ - { - "description": "the ID of zone", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "templateid", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric network", + "description": "an optional group for the virtual machine", "length": 255, - "name": "networkuuid", - "required": true, + "name": "group", + "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "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": "policyuuid", - "required": true, - "type": "string" - } - ], - "related": "listTungstenFabricPolicy,applyTungstenFabricPolicy", - "response": [ + "name": "securitygroupnames", + "related": "updateSecurityGroup", + "required": false, + "type": "list" + }, { - "description": "Tungsten-Fabric policy name", + "description": "host name for the virtual machine", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "the ID of the Userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18", + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, - {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "length": 255, + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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": "Lists all available ISO files.", - "isasync": false, - "name": "listIsos", - "params": [ { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "listall", + "name": "dynamicscalingenabled", "required": false, + "since": "4.16", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "deploymentplanner", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins).", + "description": "the ip address for default vm's network", "length": 255, - "name": "isofilter", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "keyword", + "name": "startvm", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "pagesize", + "name": "size", "required": false, - "type": "integer" + "type": "long" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "iptonetworklist", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "true if the ISO is bootable, false otherwise", + "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", "length": 255, - "name": "bootable", + "name": "iothreadsenabled", "required": false, "type": "boolean" }, { - "description": "If set to true, list only unique isos across zones", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "type": "string" + }, + { + "description": "an optional user generated name for the virtual machine", "length": 255, - "name": "showunique", + "name": "displayname", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "string" }, { - "description": "", + "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": "page", + "name": "diskofferingid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "ID of the storage pool", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" + }, + { + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "since": "4.19", "type": "uuid" }, { - "description": "true if this ISO is ready to be deployed", + "description": "True by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. False otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.", "length": 255, - "name": "isready", + "name": "vnfconfiguremanagement", "required": false, "type": "boolean" }, { - "description": "show removed ISOs as well", + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", "length": 255, - "name": "showremoved", + "name": "affinitygroupids", + "related": "", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "flag to display the resource image for the isos", - "length": 255, - "name": "showicon", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", "required": false, - "type": "boolean" + "since": "4.12", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "used to specify the vApp properties.", "length": 255, - "name": "tags", + "name": "properties", "required": false, + "since": "4.15", "type": "map" }, { - "description": "the ID of the zone", + "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "bootmode", "required": false, - "type": "uuid" + "since": "4.14.0.0", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "Deploy vm for the project", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "ID of the image or image cache store", + "description": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", "length": 255, - "name": "imagestoreid", - "related": "listSwifts,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", + "name": "securitygroupids", + "related": "updateSecurityGroup", "required": false, - "since": "4.19", - "type": "uuid" + "type": "list" }, { - "description": "list all ISOs by name", + "description": "The number of queues for multiqueue NICs.", "length": 255, - "name": "name", + "name": "nicmultiqueuenumber", "required": false, - "type": "string" + "since": "4.18", + "type": "integer" }, { - "description": "true if the ISO is publicly available to all users, false otherwise.", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "ispublic", + "name": "bootintosetup", "required": false, + "since": "4.15.0.0", "type": "boolean" }, { - "description": "the hypervisor for which to restrict the search", + "description": "availability zone for the virtual machine", "length": 255, - "name": "hypervisor", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "list ISO by ID", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "id", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "details", "required": false, - "type": "uuid" - } - ], - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "since": "4.3", + "type": "map" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "Enable packed virtqueues or not.", + "length": 255, + "name": "nicpackedvirtqueuesenabled", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "Controls specific policies on IO", + "length": 255, + "name": "iodriverpolicy", + "required": false, "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "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,listPaloAltoFirewallNetworks", + "required": false, + "type": "list" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the mac address for default vm's network", + "length": 255, + "name": "macaddress", + "required": false, "type": "string" }, { - "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.", + "length": 255, + "name": "displayvm", + "required": false, + "since": "4.2", + "type": "boolean" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" + "description": "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": "the type of the template", - "name": "templatetype", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "length": 255, + "name": "password", + "required": false, + "since": "4.19.0.0", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" - }, + "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" + } + ], + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "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 zone for this template", - "name": "zonename", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "tag value", - "name": "value", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "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": "tag key name", - "name": "key", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "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": "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 gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "the list of resource tags associated", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "additional key/value details tied with template", - "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 template name", - "name": "name", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, - {}, - {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, + {}, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "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 name of the secondary storage host for the template", - "name": "hostname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the 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 key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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" + } + ], + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "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 ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + } + ], + "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": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the 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" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "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 protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, + {}, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", - "type": "string" - } - ] - }, - { - "description": "Migrate current NFS secondary storages to use object store.", - "isasync": false, - "name": "updateCloudToUseObjectStore", - "params": [ + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, { - "description": "the URL for the image store", - "length": 255, - "name": "url", - "required": false, + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the image store provider name", - "length": 255, - "name": "provider", - "required": true, + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the name for the image store", - "length": 255, - "name": "name", - "required": false, + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "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 name of the image store", - "name": "name", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, - {}, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the url of the image store", - "name": "url", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - } - ], - "since": "4.3.0" - }, - { - "description": "Lists autoscale policies.", - "isasync": false, - "name": "listAutoScalePolicies", - "params": [ - { - "description": "the name of the autoscale policy", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the ID of the condition of the policy", - "length": 255, - "name": "conditionid", - "related": "", - "required": false, - "type": "uuid" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, + "description": "the ID of the domain in which the virtual machine exists", "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "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": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the ID of the autoscale policy", - "length": 255, - "name": "id", - "related": "listAutoScalePolicies", - "required": false, - "type": "uuid" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the ID of the autoscale vm group", - "length": 255, - "name": "vmgroupid", - "related": "listAutoScaleVmGroups", - "required": false, - "type": "uuid" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "length": 255, - "name": "action", - "required": false, + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" - } - ], - "related": "", - "response": [ + }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, - {}, { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "the ID of the virtual machine", + "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" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, {}, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the account owning the autoscale policy", - "name": "account", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vm", + "name": "project", "type": "string" - } - ] - }, - { - "description": "adds baremetal rack configuration text", - "isasync": true, - "name": "addBaremetalRct", - "params": [ - { - "description": "http url to baremetal RCT configuration", - "length": 255, - "name": "baremetalrcturl", - "required": true, - "type": "object" - } - ], - "related": "", - "response": [ + }, { - "description": "id of rct", - "name": "id", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "url", - "name": "url", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, - {}, { - "description": "the 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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the 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 project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" } - ] + ], + "since": "4.19.0" }, { - "description": "add Tungsten-Fabric network gateway to logical router", - "isasync": true, - "name": "addTungstenFabricNetworkGatewayToLogicalRouter", + "description": "Updates a network offering.", + "isasync": false, + "name": "updateNetworkOffering", "params": [ { - "description": "Tungsten-Fabric network uuid", - "length": 255, - "name": "networkuuid", - "required": true, + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric logical router uuid", + "description": "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.", "length": 255, - "name": "logicalrouteruuid", - "required": true, - "type": "string" + "name": "keepaliveenabled", + "required": false, + "type": "boolean" }, { - "description": "the ID of zone", + "description": "the id of the network offering", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, "type": "uuid" - } - ], - "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "length": 4096, + "name": "zoneid", + "required": false, + "since": "4.13", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "update state for the network offering", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "Tungsten-Fabric logical router name", - "name": "name", - "type": "string" - } - ] - }, - { - "description": "Updates a role", - "isasync": false, - "name": "updateRole", - "params": [ - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", + "description": "sort key of the network offering, integer", "length": 255, - "name": "ispublic", + "name": "sortkey", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "ID of the role", + "description": "the availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required ", "length": 255, - "name": "id", - "related": "importRole,listRoles,updateRole", - "required": true, - "type": "uuid" + "name": "availability", + "required": false, + "type": "string" }, { - "description": "The description of the role", + "description": "the display text of the network offering", "length": 255, - "name": "description", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "creates a role with this unique name", + "description": "maximum number of concurrent connections supported by the network offering", "length": 255, - "name": "name", + "name": "maxconnections", "required": false, - "type": "string" + "type": "integer" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "the name of the network offering", "length": 255, - "name": "type", + "name": "name", "required": false, "type": "string" }, { - "description": "The description of the role", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 255, - "name": "description", + "name": "domainid", "required": false, "type": "string" } ], - "related": "importRole,listRoles", + "related": "createNetworkOffering,listNetworkOfferings", "response": [ { - "description": "the name of the role", - "name": "name", - "type": "string" - }, - { - "description": "the description of the role", - "name": "description", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", "type": "boolean" }, - {}, - { - "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", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the type of the role", - "name": "type", - "type": "string" + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "id", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.9.0" - }, - { - "description": "list Tungsten-Fabric nic", - "isasync": false, - "name": "listTungstenFabricNic", - "params": [ - { - "description": "the uuid of Tungsten-Fabric nic", - "length": 255, - "name": "nicuuid", - "required": false, + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, { - "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" + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "Tungsten-Fabric nic name", - "name": "name", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" }, - {}, { - "description": "Tungsten-Fabric nic uuid", - "name": "uuid", - "type": "string" - } - ] - }, - { - "description": "Retrieves VMware DC(s) associated with a zone.", - "isasync": false, - "name": "listVmwareDcs", - "params": [ + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, { - "description": "Id of the CloudStack zone.", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", "type": "integer" }, + {}, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" - } - ], - "related": "addVmwareDc", - "response": [ + }, { - "description": "The VMware Datacenter name", - "name": "name", + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the network offering", + "name": "id", + "type": "string" + }, + { + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { @@ -96153,73 +90295,192 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" + }, + { + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "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": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + } + ], + "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": "the Zone ID associated with this VMware Datacenter", + "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": "long" + "type": "string" + }, + { + "description": "availability of the network offering", + "name": "availability", + "type": "string" + }, + { + "description": "the name of the network 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 date this network offering was created", + "name": "created", + "type": "date" }, {}, { - "description": "The VMware Datacenter ID", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" + }, + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" } ] }, { - "description": "apply Tungsten-Fabric policy", + "description": "Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password", "isasync": true, - "name": "applyTungstenFabricPolicy", + "name": "changeOutOfBandManagementPassword", "params": [ { - "description": "the major sequence of Tungsten-Fabric policy", - "length": 255, - "name": "majorsequence", - "required": true, - "type": "integer" - }, - { - "description": "the minor sequence of Tungsten-Fabric policy", - "length": 255, - "name": "minorsequence", - "required": true, - "type": "integer" - }, - { - "description": "the ID of zone", + "description": "the ID of the host", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": true, "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": true, - "type": "string" - }, - { - "description": "the uuid of network", + "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", "length": 255, - "name": "networkuuid", - "required": true, + "name": "password", + "required": false, "type": "string" } ], - "related": "listTungstenFabricPolicy", + "related": "enableOutOfBandManagementForHost", "response": [ + { + "description": "true if out-of-band management is enabled for the host", + "name": "enabled", + "type": "boolean" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" + }, + { + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { @@ -96228,120 +90489,132 @@ "type": "integer" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the out-of-band management interface username", + "name": "username", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" + }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + {}, + { + "description": "the operation result description", + "name": "description", + "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "Lists zones", + "description": "List resource detail(s)", "isasync": false, - "name": "listZones", + "name": "listResourceDetails", "params": [ { - "description": "flag to display the capacity of the zones", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "showcapacities", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "list by key", "length": 255, - "name": "page", + "name": "key", "required": false, - "type": "integer" + "type": "string" }, { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", + "description": "List by keyword", "length": 255, - "name": "available", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "flag to display the resource image for the zones", + "description": "if set to true, only details marked with display=true, are returned. False by default", "length": 255, - "name": "showicon", + "name": "fordisplay", "required": false, + "since": "4.3", "type": "boolean" }, { - "description": "the name of the zone", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "list by key, value. Needs to be passed only along with key", "length": 255, - "name": "tags", + "name": "value", "required": false, - "since": "4.3", - "type": "map" + "since": "4.4", + "type": "string" }, { - "description": "the ID of the zone", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createZone,listZones,listZones", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "the IDs of the zones, mutually exclusive with id", - "length": 255, - "name": "ids", - "related": "createZone,listZones,listZones", - "required": false, - "since": "4.19.0", - "type": "list" - }, - { - "description": "List by keyword", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { - "description": "the network type of the zone that the virtual machine belongs to", + "description": "", "length": 255, - "name": "networktype", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the domain associated with the zone", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "", @@ -96349,1367 +90622,1351 @@ "name": "pagesize", "required": false, "type": "integer" - } - ], - "related": "createZone,listZones", - "response": [ - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" }, { - "description": "Zone name", - "name": "name", + "description": "list by resource type", + "length": 255, + "name": "resourcetype", + "required": true, "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", - "response": [ - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "list by resource id", + "length": 255, + "name": "resourceid", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if 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 dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, {}, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" - }, - { - "description": "Zone Token", - "name": "zonetoken", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "resource type", + "name": "resourcetype", "type": "string" - }, + } + ], + "since": "4.2" + }, + { + "description": "Dedicate an existing cluster", + "isasync": true, + "name": "dedicateCluster", + "params": [ { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the name of the account which needs dedication. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" }, + { + "description": "the ID of the Cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "related": "listDedicatedClusters", + "response": [ { "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "the Account ID of the cluster", + "name": "accountid", "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "the ID of the cluster", + "name": "clusterid", + "type": "string" + }, + { + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, {}, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "the domain ID of the cluster", + "name": "domainid", + "type": "string" } ] }, { - "description": "Lists remote access vpns", + "description": "Creates a network offering.", "isasync": false, - "name": "listRemoteAccessVpns", + "name": "createNetworkOffering", "params": [ { - "description": "List by keyword", + "description": "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6", "length": 255, - "name": "keyword", + "name": "internetprotocol", "required": false, + "since": "4.17.0", "type": "string" }, { - "description": "list remote access VPNs for certain network", + "description": "true if network offering for NSX network offering supports Load balancer service.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", + "name": "nsxsupportlb", "required": false, - "since": "4.3", - "type": "uuid" + "since": "4.20.0", + "type": "boolean" }, { - "description": "Lists remote access vpn rule with the specified ID", + "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": "id", - "related": "listRemoteAccessVpns,updateRemoteAccessVpn", + "name": "keepaliveenabled", "required": false, - "since": "4.3", - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", "length": 255, - "name": "fordisplay", + "name": "egressdefaultpolicy", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "true if the network offering is IP conserve mode enabled", "length": 255, - "name": "account", + "name": "conservemode", + "required": false, + "type": "boolean" + }, + { + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the traffic type for the network offering. Supported type in current release is GUEST only", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "traffictype", + "required": true, + "type": "string" + }, + { + "description": "guest type of the network offering: Shared or Isolated", + "length": 255, + "name": "guestiptype", + "required": true, + "type": "string" + }, + { + "description": "desired service capabilities as part of network offering", + "length": 255, + "name": "servicecapabilitylist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "", + "description": "the display text of the network offering, defaults to the value of 'name'.", "length": 255, - "name": "pagesize", + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "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": "listall", + "name": "serviceproviderlist", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "public ip address id of the vpn server", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "uuid" + "since": "4.13", + "type": "list" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "true if network offering supports vlans", "length": 255, - "name": "isrecursive", + "name": "specifyvlan", "required": false, "type": "boolean" }, { - "description": "", + "description": "services supported by the network offering", "length": 255, - "name": "page", + "name": "supportedservices", "required": false, - "type": "integer" + "type": "list" }, { - "description": "list only resources belonging to the domain specified", + "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "fortungsten", "required": false, - "type": "uuid" - } - ], - "related": "updateRemoteAccessVpn", - "response": [ - { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup", + "length": 255, + "name": "details", + "required": false, + "since": "4.2.0", + "type": "map" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "maximum number of concurrent connections supported by the network offering", + "length": 255, + "name": "maxconnections", + "required": false, + "type": "integer" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "length": 255, + "name": "routingmode", + "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", - "type": "string" + "description": "true if network offering for NSX network offering supports Internal Load balancer service.", + "length": 255, + "name": "nsxsupportsinternallb", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "list" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "true if network offering supports choosing AS number", + "length": 255, + "name": "specifyasnumber", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" + "description": "true if network offering is meant to be used for VPC, false otherwise.", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" }, - {}, - {}, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", + "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "length": 255, + "name": "ispersistent", + "required": false, "type": "boolean" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", - "type": "string" + "description": "data transfer rate in megabits per second allowed", + "length": 255, + "name": "networkrate", + "required": false, + "type": "integer" }, { - "description": "the state of the rule", - "name": "state", + "description": "the availability of network offering. The default value is Optional. Another value is Required, which will make it as the default network offering for new networks ", + "length": 255, + "name": "availability", + "required": false, "type": "string" }, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" + "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", + "length": 255, + "name": "specifyipranges", + "required": false, + "type": "boolean" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "length": 255, + "name": "networkmode", + "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" - } - ] - }, - { - "description": "Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.", - "isasync": false, - "name": "removeQuarantinedIp", - "params": [ - { - "description": "The reason for removing the public IP address from quarantine prematurely.", + "description": "true if network offering is meant to be used for NSX, false otherwise.", "length": 255, - "name": "removalreason", - "required": true, - "type": "string" + "name": "fornsx", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "description": "set to true if the offering is to be enabled during creation. Default is false", "length": 255, - "name": "ipaddress", + "name": "enable", "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "description": "the name of the network offering", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "description": "the service offering ID used by virtual router provider", "length": 255, - "name": "id", - "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" } ], - "related": "listQuarantinedIps,updateQuarantinedIp", + "related": "listNetworkOfferings", "response": [ { - "description": "ID of the quarantine process.", + "description": "the id of the network offering", "name": "id", "type": "string" }, { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "End date for the quarantine.", - "name": "enddate", - "type": "date" + "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": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, {}, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", - "type": "string" + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, - {}, { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" - } - ], - "since": "4.19" - }, - { - "description": "Deletes a network ACL", - "isasync": true, - "name": "deleteNetworkACLList", - "params": [ + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { - "description": "the ID of the network ACL", - "length": 255, - "name": "id", - "related": "createNetworkACLList", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" + }, { - "description": "true if operation is executed successfully", - "name": "success", + "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": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, - {} - ] - }, - { - "description": "Removes secondary IP from the NIC.", - "isasync": true, - "name": "removeIpFromNic", - "params": [ { - "description": "the ID of the secondary ip address to nic", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Creates a system virtual-machine that implements network services", - "isasync": true, - "name": "createServiceInstance", - "params": [ - { - "description": "The name of the service instance", - "length": 255, - "name": "name", - "required": true, + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "Availability zone for the service instance", - "length": 255, + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", - "length": 255, + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "The service offering ID that defines the resources consumed by the service appliance", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The left (inside) network for service instance", - "length": 255, - "name": "leftnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" }, { - "description": "Project ID for the service instance", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, { - "description": "The right (outside) network ID for the service instance", - "length": 255, - "name": "rightnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { - "description": "An optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "The template ID that specifies the image for the service appliance", - "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {} - ] + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" + } + ], + "since": "3.0.0" }, { - "description": "Releases a Public IP range back to the system pool", - "isasync": false, - "name": "releasePublicIpRange", + "description": "Creates an IP forwarding rule", + "isasync": true, + "name": "createIpForwardingRule", "params": [ { - "description": "the id of the Public IP range", + "description": "the end port for the rule", "length": 255, - "name": "id", - "related": "dedicatePublicIpRange", - "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", + "name": "endport", + "required": false, "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 public IP address ID of the forwarding rule, already associated via associateIp", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" }, - {} - ] - }, - { - "description": "lists network that are using a netscaler load balancer device", - "isasync": false, - "name": "listNetscalerLoadBalancerNetworks", - "params": [ { - "description": "", + "description": "the start port for the rule", "length": 255, - "name": "pagesize", - "required": false, + "name": "startport", + "required": true, "type": "integer" }, { - "description": "List by keyword", + "description": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default", "length": 255, - "name": "keyword", + "name": "openfirewall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "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": "page", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { - "description": "netscaler load balancer device ID", + "description": "the protocol for the rule. Valid values are TCP or UDP.", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter", + "name": "protocol", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "related": "createPortForwardingRule,updatePortForwardingRule", "response": [ { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "type": "string" }, + {}, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" }, + {}, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "is firewall for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the network", - "name": "name", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project 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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "list" }, { - "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 zone the network belongs to", - "name": "zonename", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "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": "Lists the network Interfaces of elastistor", + "isasync": false, + "name": "listElastistorInterface", + "params": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "controller id", + "length": 255, + "name": "controllerid", + "required": false, "type": "string" - }, + } + ], + "related": "listElastistorVolume", + "response": [ { - "description": "the network's netmask", - "name": "netmask", + "description": "synchronization", + "name": "sync", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the id of the volume", + "name": "id", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "compression", + "name": "compression", + "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "deduplication", + "name": "deduplication", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the name of the volume", + "name": "name", "type": "string" }, + {} + ] + }, + { + "description": "Updates load balancer stickiness policy", + "isasync": true, + "name": "updateLBStickinessPolicy", + "params": [ { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", - "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": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "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": "state of the network", - "name": "state", - "type": "string" + "description": "id of lb stickiness policy", + "length": 255, + "name": "id", + "related": "createLBStickinessPolicy,updateLBStickinessPolicy", + "required": true, + "type": "uuid" + } + ], + "related": "createLBStickinessPolicy", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the name of the Stickiness policy", + "name": "name", + "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { - "description": "the list of services", - "name": "service", + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", "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 LB Stickiness policy ID", + "name": "id", + "type": "string" }, { - "description": "the service name", + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "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 params of the policy", + "name": "params", + "type": "map" + }, + { + "description": "the name of the Stickiness policy", "name": "name", "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the 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": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - } - ], - "type": "list" + "description": "the state of the policy", + "name": "state", + "type": "string" } ], "type": "list" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the policy", + "name": "state", + "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 zone the Stickiness policy belongs to", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "The external id of the network", - "name": "externalid", + "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 domain of the Stickiness policy", + "name": "domain", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" + } + ], + "since": "4.4" + }, + { + "description": "Lists all Pods.", + "isasync": false, + "name": "listPods", + "params": [ { - "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 pods by allocation state", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "list Pods by name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list Pods by Zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, + { + "description": "flag to display the capacity of the pods", + "length": 255, + "name": "showcapacities", + "required": false, + "type": "boolean" + }, + { + "description": "list Pods by ID", + "length": 255, + "name": "id", + "related": "listPods,createManagementNetworkIpRange", + "required": false, + "type": "uuid" + } + ], + "related": "createManagementNetworkIpRange", + "response": [ {}, { - "description": "the network's gateway", + "description": "the gateway of the Pod", "name": "gateway", "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" }, { - "description": "the list of resource tags associated with network", - "name": "tags", + "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", + "name": "forsystemvms", + "type": "list" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" + }, + { + "description": "the name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity name", + "name": "name", "type": "string" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" } ], "type": "list" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" - }, - { - "description": "zone id of the network", + "description": "the Zone ID of the Pod", "name": "zoneid", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "the 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 domain name of the network owner", - "name": "domain", - "type": "string" - }, - { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the Zone name of the Pod", + "name": "zonename", "type": "string" }, { - "description": "the id of the network", + "description": "the ID of the Pod", "name": "id", "type": "string" }, + {}, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", + "name": "vlanid", + "type": "list" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", - "type": "string" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" } ] }, { - "description": "create Tungsten-Fabric public network", - "isasync": false, - "name": "createTungstenFabricPublicNetwork", + "description": "delete Tungsten-Fabric address group", + "isasync": true, + "name": "deleteTungstenFabricAddressGroup", "params": [ { "description": "the ID of zone", "length": 255, "name": "zoneid", - "related": "createZone,listZones", + "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric address group", + "length": 255, + "name": "addressgroupuuid", + "required": true, + "type": "string" } ], "response": [ - {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the 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", @@ -97718,121 +91975,149 @@ ] }, { - "description": "Starts a system virtual machine.", + "description": "Stops a running CloudManaged Kubernetes cluster", "isasync": true, - "name": "startSystemVm", + "name": "stopKubernetesCluster", "params": [ { - "description": "The ID of the system virtual machine", + "description": "the ID of the Kubernetes cluster", "length": 255, "name": "id", - "related": "migrateSystemVm,startSystemVm", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", "required": true, "type": "uuid" } ], - "related": "migrateSystemVm", "response": [ - {}, { - "description": "the systemvm agent version", - "name": "version", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", - "type": "string" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Lists IPv4 subnets for zone.", + "isasync": false, + "name": "listIpv4SubnetsForZone", + "params": [ { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", - "type": "string" + "description": "UUID of zone to which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "project who which the IPv4 subnet is dedicated to", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "the name of the system VM", - "name": "name", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "the domain ID which the IPv4 subnet is dedicated to.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" - }, + "description": "UUID of the IPv4 subnet.", + "length": 255, + "name": "id", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "required": false, + "type": "uuid" + } + ], + "related": "dedicateIpv4SubnetForZone", + "response": [ { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobid", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, + {}, + {}, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the project name of the IPv4 subnet", + "name": "project", "type": "string" }, { @@ -97846,147 +92131,88 @@ "type": "string" }, { - "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": "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 host ID for the system VM", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" - }, - { - "description": "the ID of the system VM", - "name": "id", - "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 control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { - "description": "the Zone name for the system VM", + "description": "name of zone to which the IPv4 subnet belongs to.", "name": "zonename", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" - }, - { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" - }, - { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" - }, - { - "description": "the state of the system VM", - "name": "state", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Lists supported methods of network isolation", - "isasync": false, - "name": "listNetworkIsolationMethods", + "description": "Adds account to a project", + "isasync": true, + "name": "addAccountToProject", "params": [ { - "description": "List by keyword", + "description": "ID of the project to add the account to", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "createProject", + "required": true, + "type": "uuid" + }, + { + "description": "Project role type to be assigned to the user - Admin/Regular; default: Regular", + "length": 255, + "name": "roletype", "required": false, "type": "string" }, { - "description": "", + "description": "ID of the project role", "length": 255, - "name": "pagesize", + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "email to which invitation to the project is going to be sent", "length": 255, - "name": "page", + "name": "email", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "name of the account to be added to the project", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], - "related": "", "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": "Network isolation method name", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the UUID of the latest async job acting on this object", @@ -97994,271 +92220,237 @@ "type": "string" } ], - "since": "4.2.0" + "since": "3.0.0" }, { - "description": "Registers an existing VNF template into the CloudStack cloud. ", + "description": "Lists all available snapshots for the account.", "isasync": false, - "name": "registerVnfTemplate", + "name": "listSnapshots", "params": [ { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "the name of the template", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "the ID of the disk volume", "length": 255, - "name": "isdynamicallyscalable", + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "isfeatured", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" - }, - { - "description": "Register template for the project", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "true if the template or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" - }, - { - "description": "the tag for this template.", + "description": "List by keyword", "length": 255, - "name": "templatetag", + "name": "keyword", "required": false, "type": "string" }, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", "length": 255, - "name": "vnfdetails", + "name": "intervaltype", "required": false, - "type": "map" + "type": "string" }, { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "vnfnics", + "name": "tags", "required": false, "type": "map" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "list snapshots by zone id", "length": 255, - "name": "deployasis", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "uuid" }, { - "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "description": "", "length": 255, - "name": "zoneids", - "related": "createZone,listZones", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "bits", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "true if this template requires HVM", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "requireshvm", + "name": "projectid", + "related": "createProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "lists snapshot by snapshot ID", "length": 255, - "name": "account", + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "If set to false, list templates across zones and their storages", "length": 255, - "name": "passwordenabled", + "name": "showunique", "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "lists snapshot by snapshot name", "length": 255, - "name": "checksum", + "name": "name", "required": false, "type": "string" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", "length": 255, - "name": "templatetype", + "name": "locationtype", "required": false, "since": "4.19.0", "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" - }, - { - "description": "true if the template is available to all accounts; default is true", + "description": "valid values are MANUAL or RECURRING.", "length": 255, - "name": "ispublic", + "name": "snapshottype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "ID of the image or image cache store", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, + "since": "4.19", "type": "uuid" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", + "description": "the IDs of the snapshots, mutually exclusive with id", "length": 255, - "name": "ostypeid", - "related": "", + "name": "ids", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, - "type": "uuid" + "since": "4.9", + "type": "list" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "ID of the storage pool", "length": 255, - "name": "isrouting", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "boolean" + "since": "4.19", + "type": "uuid" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "directdownload", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "page", "required": false, - "type": "uuid" - }, - { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", - "length": 255, - "name": "format", - "required": true, - "type": "string" + "type": "integer" } ], - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "ID of the snapshot", + "name": "id", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" }, + {}, { - "description": "the type of the template", - "name": "templatetype", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -98267,8 +92459,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -98277,2937 +92469,2737 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "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 size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, - { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "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": "the project id of the template", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", - "type": "string" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the date this template was created", + "description": " the date the snapshot was created", "name": "created", "type": "date" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "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 hypervisor on which the template runs", - "name": "hypervisor", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", "type": "boolean" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the project name of the snapshot", + "name": "project", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, - {}, { "description": "the status of the template", "name": "status", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the account name to which the template belongs", + "description": "the account associated with the snapshot", "name": "account", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" - }, - { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" }, + {}, { - "description": "checksum of the template", - "name": "checksum", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, - {}, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", + "description": "download progress of a snapshot", + "name": "downloaddetails", "type": "map" - }, - { - "description": "the template name", - "name": "name", - "type": "string" } - ], - "since": "4.19.0" + ] }, { - "description": "Lists host HA resources", - "isasync": false, - "name": "listHostHAResources", + "description": "migrates resources from one secondary storage to destination image store", + "isasync": true, + "name": "migrateResourceToAnotherSecondaryStorage", "params": [ { - "description": "List by host ID", + "description": "id(s) of the templates to be migrated", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "templates", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, + "type": "list" + }, + { + "description": "id(s) of the snapshots to be migrated", + "length": 255, + "name": "snapshots", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", + "required": false, + "type": "list" + }, + { + "description": "id of the image store from where the data is to be migrated", + "length": 255, + "name": "srcpool", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "uuid" + }, + { + "description": "id of the destination secondary storage pool to which the resources are to be migrated", + "length": 255, + "name": "destpool", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, "type": "uuid" } ], - "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", + "related": "migrateSecondaryStorageData", "response": [ { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "description": "the host HA provider", - "name": "haprovider", + "description": "Response message from migration of secondary storage data objects", + "name": "message", "type": "string" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Type of migration requested for", + "name": "migrationtype", "type": "string" }, {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, - { - "description": "operation status", - "name": "status", - "type": "boolean" - }, - {} + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], - "since": "4.11" + "since": "4.19.0" }, { - "description": "Lists VM stats", + "description": "Deletes a keypair by name", "isasync": false, - "name": "listVirtualMachinesUsageHistory", + "name": "deleteSSHKeyPair", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, - { - "description": "", + "description": "the domain ID associated with the keypair", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the virtual machine.", + "description": "the project associated with keypair", "length": 255, - "name": "id", - "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,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "Name of the keypair", "length": 255, "name": "name", - "required": false, + "required": true, "type": "string" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id.", - "length": 255, - "name": "ids", - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": false, - "type": "list" - }, - { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "description": "List by keyword", + "description": "the account associated with the keypair. Must be used with the domainId parameter.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" } ], - "related": "listSystemVmsUsageHistory", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if 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 list of VM stats", - "name": "stats", - "type": "list" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "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 virtual machine", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" - }, - {}, - {} - ], - "since": "4.17" + } + ] }, { - "description": "list Tungsten-Fabric firewall policy", + "description": "Searches LDAP based on the username attribute", "isasync": false, - "name": "listTungstenFabricFirewallPolicy", + "name": "searchLdap", "params": [ { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "query to search using", "length": 255, - "name": "applicationpolicysetuuid", - "required": false, + "name": "query", + "related": "searchLdap", + "required": true, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "List by keyword", "length": 255, - "name": "firewallpolicyuuid", + "name": "keyword", "required": false, "type": "string" }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - }, { "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", + "description": "The user's principle", + "name": "principal", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "The user's lastname", + "name": "lastname", "type": "string" }, { - "description": "list Tungsten-Fabric firewall rule", - "name": "firewallrule", - "type": "list" + "description": "The user's domain", + "name": "domain", + "type": "string" }, + {}, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", + "description": "The user's username", + "name": "username", "type": "string" }, { - "description": "Tungsten-Fabric firewall policy uuid", - "name": "uuid", + "description": "The user's email", + "name": "email", + "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": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host.", - "isasync": true, - "name": "declareHostAsDegraded", + "description": "Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown", + "isasync": false, + "name": "readyForShutdown", "params": [ { - "description": "host ID", + "description": "the uuid of the management server", "length": 255, - "name": "id", - "related": "cancelHostAsDegraded,declareHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, + "name": "managementserverid", + "related": "listManagementServers", + "required": false, "type": "uuid" } ], - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "related": "prepareForShutdown", "response": [ - {}, - { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" - }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" }, + {}, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "The id of the management server", + "name": "managementserverid", "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", "type": "boolean" }, + {}, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.19.0" + }, + { + "description": "create Tungsten-Fabric logical router", + "isasync": true, + "name": "createTungstenFabricLogicalRouter", + "params": [ { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the host", + "description": "Tungsten-Fabric logical router name", + "length": 255, "name": "name", + "required": true, "type": "string" - }, + } + ], + "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", + "response": [ { - "description": "events available for the host", - "name": "events", - "type": "string" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": "the admin that annotated this host", - "name": "username", - "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": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "Tungsten-Fabric logical router name", + "name": "name", "type": "string" - }, + } + ] + }, + { + "description": "Start a Shared FileSystem", + "isasync": true, + "name": "startSharedFileSystem", + "params": [ { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" + } + ], + "related": "listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "response": [ { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" - }, - { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, { - "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 CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum 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": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - } - ], + "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": "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": "GPU cards present in the host", - "name": "gpugroupname", + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "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 type of the nic", + "name": "type", "type": "string" } ], "type": "list" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "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": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "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": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, - {}, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, + {}, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "description of the shared filesystem", + "name": "description", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "size of the shared filesystem", + "name": "size", "type": "long" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "name of the shared filesystem", + "name": "name", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" } ], - "since": "4.16.0.0" + "since": "4.20.0" }, { - "description": "Creates a Kubernetes cluster", + "description": "create Tungsten-Fabric firewall", "isasync": true, - "name": "createKubernetesCluster", + "name": "createTungstenFabricFirewallRule", "params": [ { - "description": "URL for the docker image private registry", + "description": "Tungsten-Fabric firewall rule source address group uuid", "length": 255, - "name": "dockerregistryurl", + "name": "srcaddressgroupuuid", "required": false, "type": "string" }, { - "description": "password for the docker image private registry", + "description": "the uuid of Tungsten-Fabric destination network", "length": 255, - "name": "dockerregistrypassword", + "name": "destnetworkuuid", "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": false, - "type": "long" - }, - { - "description": "name for the Kubernetes cluster", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "name", + "name": "firewallpolicyuuid", "required": true, "type": "string" }, { - "description": "description for the Kubernetes cluster", + "description": "the sequence of Tungsten-Fabric firewall rule", "length": 255, - "name": "description", - "required": false, - "type": "string" + "name": "sequence", + "required": true, + "type": "integer" }, { - "description": "Deploy cluster for the project", + "description": "Tungsten-Fabric firewall rule service group uuid", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "name": "servicegroupuuid", + "required": true, + "type": "string" }, { - "description": "availability zone in which Kubernetes cluster to be launched", + "description": "the ID of zone", "length": 255, "name": "zoneid", - "related": "createZone,listZones", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "Network in which Kubernetes cluster is to be launched", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "root disk size in GB for each node", - "length": 255, - "name": "noderootdisksize", - "required": false, - "type": "long" - }, - { - "description": "user name for the docker image private registry", + "description": "Tungsten-Fabric firewall rule source tag uuid", "length": 255, - "name": "dockerregistryusername", + "name": "srctaguuid", "required": false, "type": "string" }, { - "description": "number of Kubernetes cluster control nodes, default is 1", - "length": 255, - "name": "controlnodes", - "required": false, - "type": "long" - }, - { - "description": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", + "description": "Tungsten-Fabric firewall rule tag type uuid", "length": 255, - "name": "clustertype", + "name": "tagtypeuuid", "required": false, - "since": "4.19.0", "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "Tungsten-Fabric firewall rule action", "length": 255, - "name": "account", - "required": false, + "name": "action", + "required": true, "type": "string" }, { - "description": "name of the ssh key pair used to login to the virtual machines", + "description": "Tungsten-Fabric firewall rule name", "length": 255, - "name": "keypair", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "description": "Tungsten-Fabric firewall rule destination address group uuid", "length": 255, - "name": "masternodes", + "name": "destaddressgroupuuid", "required": false, - "type": "long" + "type": "string" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "Tungsten-Fabric firewall rule destination tag uuid", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "desttaguuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "description": "Tungsten-Fabric firewall rule direction", "length": 255, - "name": "externalloadbalanceripaddress", - "required": false, + "name": "direction", + "required": true, "type": "string" }, { - "description": "Kubernetes version with which cluster to be launched", + "description": "the uuid of Tungsten-Fabric source network", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "srcnetworkuuid", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "startKubernetesCluster", + "related": "listTungstenFabricFirewallRule", "response": [ { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", + "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, + {}, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", + "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", + "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, + {}, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + } + ] + }, + { + "description": "Lists all configurations.", + "isasync": false, + "name": "listConfigurations", + "params": [ + { + "description": "lists configurations by category", + "length": 255, + "name": "category", + "required": false, + "type": "string" + }, + { + "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": "the ID of the Image Store to update the parameter value for corresponding image store", + "length": 255, + "name": "imagestoreuuid", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the ID of the Zone to update the parameter value for corresponding zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Account to update the parameter value for corresponding account", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Domain to update the parameter value for corresponding domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "lists configuration by subgroup name (primarily used for UI)", + "length": 255, + "name": "subgroup", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {}, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "lists configuration by parent name (primarily used for UI)", + "length": 255, + "name": "parent", + "required": false, + "since": "4.18.0", + "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "lists configuration by name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "lists configuration by group name (primarily used for UI)", + "length": 255, + "name": "group", + "required": false, + "since": "4.18.0", + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the possible options of the configuration value", + "name": "options", + "type": "string" }, + {}, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the category of the configuration", + "name": "category", "type": "string" }, + { + "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": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the group of the configuration", + "name": "group", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the configuration is dynamic", + "name": "isdynamic", "type": "boolean" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the name of the configuration", + "name": "name", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the component of the configuration", + "name": "component", "type": "string" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "the value of the configuration", + "name": "id", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "List a storage network IP range.", - "isasync": false, - "name": "listStorageNetworkIpRange", + "description": "Scales a created, running or stopped CloudManaged Kubernetes cluster", + "isasync": true, + "name": "scaleKubernetesCluster", "params": [ { - "description": "List by keyword", + "description": "the IDs of the nodes to be removed", "length": 255, - "name": "keyword", + "name": "nodeids", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": false, - "type": "string" + "type": "list" }, { - "description": "", + "description": "Whether autoscaling is enabled for the cluster", "length": 255, - "name": "page", + "name": "autoscalingenabled", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", + "description": "Maximum number of worker nodes in the cluster", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "maxsize", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", + "description": "Minimum number of worker nodes in the cluster", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "minsize", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", + "description": "number of Kubernetes cluster nodes", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "name": "size", "required": false, + "type": "long" + }, + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "required": true, "type": "uuid" }, { - "description": "", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "pagesize", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "createStorageNetworkIpRange", + "related": "createKubernetesCluster,startKubernetesCluster", "response": [ { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, - {}, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "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": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "Configures a virtual router element.", - "isasync": true, - "name": "configureVirtualRouterElement", - "params": [ { - "description": "the ID of the virtual router provider", - "length": 255, - "name": "id", - "related": "configureVirtualRouterElement,listVirtualRouterElements", - "required": true, - "type": "uuid" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "length": 255, - "name": "enabled", - "required": true, - "type": "boolean" - } - ], - "related": "listVirtualRouterElements", - "response": [ - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, - {}, { - "description": "the domain associated with the provider", - "name": "domain", + "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": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the id of the router", - "name": "id", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, + {}, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, - {}, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - } - ] - }, - { - "description": "Deletes a specified domain", - "isasync": true, - "name": "deleteDomain", - "params": [ { - "description": "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "ID of domain to delete", - "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "keypair details", + "name": "keypair", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" - } - ] - }, - { - "description": "Enables HA for a host", - "isasync": true, - "name": "enableHAForHost", - "params": [ + }, { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "related": "configureHAForHost,disableHAForHost,listHostHAProviders", - "response": [ + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" + }, + {}, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" }, - {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, - {}, { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" } - ], - "since": "4.11" + ] }, { - "description": "Migrate volume", + "description": "Stops a NetScalervm.", "isasync": true, - "name": "migrateVolume", + "name": "stopNetScalerVpx", "params": [ { - "description": "destination storage pool ID to migrate the volume to", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, - "type": "uuid" - }, - { - "description": "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.", - "length": 255, - "name": "newdiskofferingid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the volume", + "description": "the ID of the NetScaler vm", "length": 255, - "name": "volumeid", - "related": "createVolume,migrateVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "id", + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "required": true, "type": "uuid" }, { - "description": "if the volume should be live migrated when it is attached to a running vm", + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", "length": 255, - "name": "livemigrate", + "name": "forced", "required": false, "type": "boolean" } ], - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" - }, - { - "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": "name of the disk volume", - "name": "name", - "type": "string" + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "list" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", "type": "boolean" }, + {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "pod name of the volume", - "name": "podname", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, + {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with the router", + "name": "nic", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" } ], "type": "set" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, - {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "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 hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the template name for the router", + "name": "templatename", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "create Tungsten-Fabric application policy set", - "isasync": true, - "name": "createTungstenFabricApplicationPolicySet", + "description": "Deletes a vm group", + "isasync": false, + "name": "deleteInstanceGroup", "params": [ { - "description": "Tungsten-Fabric application policy set name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the ID of zone", + "description": "the ID of the instance group", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "id", + "related": "updateInstanceGroup", "required": true, "type": "uuid" } ], - "related": "", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" - }, - {}, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" - }, - { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, { - "description": "A command to list events.", - "isasync": false, - "name": "listEvents", + "description": "Updates traffic type of a physical network", + "isasync": true, + "name": "updateTrafficType", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "hypervnetworklabel", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the type of the resource associated with the event", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "resourcetype", + "name": "vmwarenetworklabel", "required": false, - "since": "4.17.0", "type": "string" }, { - "description": "List by keyword", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", "length": 255, - "name": "keyword", + "name": "xennetworklabel", "required": false, "type": "string" }, { - "description": "the time the event was entered", + "description": "traffic type id", "length": 255, - "name": "entrytime", - "required": false, - "type": "integer" + "name": "id", + "related": "addTrafficType,updateTrafficType", + "required": true, + "type": "uuid" }, { - "description": "the event level (INFO, WARN, ERROR)", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, - "name": "level", + "name": "kvmnetworklabel", "required": false, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "listall", + "name": "ovm3networklabel", "required": false, - "type": "boolean" + "type": "string" + } + ], + "related": "addTrafficType", + "response": [ + {}, + { + "description": "the trafficType to be added to the physical network", + "name": "traffictype", + "type": "string" }, { - "description": "the ID of the resource associated with the event", - "length": 255, - "name": "resourceid", - "required": false, - "since": "4.17.0", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, { - "description": "the ID of the event", - "length": 255, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", + "type": "string" + }, + { + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", + "type": "string" + }, + { + "description": "id of the network provider", "name": "id", - "related": "listEvents", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the duration of the event", + "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" + }, + {} + ], + "since": "3.0.0" + }, + { + "description": "List Conditions for VM auto scaling", + "isasync": false, + "name": "listConditions", + "params": [ + { + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "duration", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "startdate", + "name": "account", "required": false, - "type": "date" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "isrecursive", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "the event type (see event types)", + "description": "Counter-id of the condition.", "length": 255, - "name": "type", + "name": "counterid", + "related": "createCounter", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the ID of the policy", "length": 255, - "name": "page", + "name": "policyid", + "related": "listAutoScalePolicies", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "true to list archived events otherwise false", + "description": "", "length": 255, - "name": "archived", + "name": "pagesize", "required": false, - "since": "4.19.0", - "type": "boolean" + "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", + "description": "List by keyword", "length": 255, - "name": "startid", - "related": "listEvents", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "account", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "createProject", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")", + "description": "ID of the Condition.", "length": 255, - "name": "enddate", + "name": "id", + "related": "listConditions", "required": false, - "type": "date" + "type": "uuid" } ], "related": "", "response": [ {}, + { + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", - "name": "account", + "description": "path of the domain to which the Condition owner belongs", + "name": "domainpath", "type": "string" }, { - "description": "the 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": "a brief description of the event", - "name": "description", + "description": "the Id of the Counter.", + "name": "counterid", "type": "string" }, { - "description": "the name of the account's domain", - "name": "domain", + "description": "the project name of the Condition", + "name": "project", "type": "string" }, + {}, { - "description": "the state of the event", - "name": "state", - "type": "state" - }, - { - "description": "the type of the event (see event types)", - "name": "type", + "description": "the id of the Condition", + "name": "id", "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", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "whether the event is parented", - "name": "parentid", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" }, { - "description": "the ID of the event", - "name": "id", + "description": "the Name of the Counter.", + "name": "countername", "type": "string" }, - {}, { - "description": "the type of the resource", - "name": "resourcetype", + "description": "the owner of the Condition.", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" }, { - "description": "the event level (INFO, WARN, ERROR)", - "name": "level", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { - "description": "the name of the resource", - "name": "resourcename", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" + } + ] + }, + { + "description": "migrates data objects from one secondary storage to destination image store(s)", + "isasync": true, + "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,addImageStore", + "required": true, + "type": "list" }, { - "description": "the date the event was created", - "name": "created", - "type": "date" + "description": "Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete", + "length": 255, + "name": "migrationtype", + "required": false, + "type": "string" }, { - "description": "whether the event has been archived or not", - "name": "archived", + "description": "id of the image store from where the data is to be migrated", + "length": 255, + "name": "srcpool", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the project name of the address", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the account's domain", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Response message from migration of secondary storage data objects", + "name": "message", "type": "string" - } - ] + }, + { + "description": "Type of migration requested for", + "name": "migrationtype", + "type": "string" + }, + {} + ], + "since": "4.15.0" }, { - "description": "Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect.", + "description": "Destroys a Volume.", "isasync": true, - "name": "updateVMAffinityGroup", + "name": "destroyVolume", "params": [ { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "description": "The ID of the volume", "length": 255, - "name": "affinitygroupnames", - "related": "", - "required": false, - "type": "list" + "name": "id", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" }, { - "description": "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": "If true is passed, the volume is expunged immediately. False by default.", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "expunge", "required": false, - "type": "list" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" + "since": "4.6.0", + "type": "boolean" } ], - "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,deployVnfAppliance,importUnmanagedInstance,importVm", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the date the disk volume 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": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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 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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "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", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the 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": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, + {}, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "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", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", @@ -101219,8 +95211,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -101229,8 +95221,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -101243,560 +95235,240 @@ "name": "projectid", "type": "string" }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "tag key name", "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, - {}, - {}, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the 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" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, - {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "id of the virtual machine", + "name": "virtualmachineid", "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", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "cluster name where the volume is allocated", + "name": "clustername", "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 isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "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 gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Adds traffic type to a physical network", + "isasync": true, + "name": "addTrafficType", + "params": [ { - "description": "the account associated with the virtual machine", - "name": "account", + "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", + "required": false, "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "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 trafficType to be added to the physical network", + "length": 255, + "name": "traffictype", + "required": true, "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "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": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - } - ] - }, - { - "description": "Lists HA providers", - "isasync": false, - "name": "listHostHAProviders", - "params": [ - { - "description": "Hypervisor type of the resource", + "description": "The VLAN id to be used for Management traffic by VMware host", "length": 255, - "name": "hypervisor", - "required": true, + "name": "vlan", + "required": false, "type": "string" - } - ], - "related": "configureHAForHost,disableHAForHost", - "response": [ - { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "operation status", - "name": "status", - "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", + "length": 255, + "name": "hypervnetworklabel", + "required": false, "type": "string" }, - {}, { - "description": "the ID of the host", - "name": "hostid", + "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 host HA provider", - "name": "haprovider", + "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 HA state of the host", - "name": "hastate", - "type": "hastate" - }, - {} - ], - "since": "4.11" - }, - { - "description": "Registers NCC Service Package", - "isasync": false, - "name": "registerNetscalerServicePackage", - "params": [ - { - "description": "Description of Service Package", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, - "name": "description", - "required": true, + "name": "vmwarenetworklabel", + "required": false, "type": "string" }, { - "description": "Name of the service Package.", + "description": "the Physical Network ID", "length": 255, - "name": "name", + "name": "physicalnetworkid", + "related": "updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" } ], - "related": "listRegisteredServicePackages", + "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Service Package UUID", - "name": "id", + "description": "the trafficType to be added to the physical network", + "name": "traffictype", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The network name label of the physical device dedicated to this traffic on a XenServer host", + "name": "xennetworklabel", "type": "string" }, - {}, { - "description": "Description of Service Package", - "name": "description", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "type": "string" }, { - "description": "Service Package Name", - "name": "name", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", + "name": "ovm3networklabel", "type": "string" }, - {} - ] - }, - { - "description": "Creates resource tag(s)", - "isasync": true, - "name": "createTags", - "params": [ - { - "description": "list of resources to create the tags for", - "length": 255, - "name": "resourceids", - "required": true, - "type": "list" - }, + {}, { - "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", - "length": 255, - "name": "customer", - "required": false, + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, - { - "description": "Map of tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": true, - "type": "map" - }, - { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" - } - ], - "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.0.0" - }, - { - "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", - "isasync": false, - "name": "listCaCertificate", - "params": [ - { - "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", - "length": 255, - "name": "provider", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -101804,334 +95476,187 @@ "type": "string" }, { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "id of the network provider", + "name": "id", "type": "string" }, { - "description": "Private key for the certificate", - "name": "privatekey", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "type": "string" }, { - "description": "The client certificate", - "name": "certificate", + "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" } ], - "since": "4.11.0" + "since": "3.0.0" }, { - "description": "Create an Internal Load Balancer element.", - "isasync": true, - "name": "createInternalLoadBalancerElement", + "description": "Lists the secondary storage selectors and their rules.", + "isasync": false, + "name": "listSecondaryStorageSelectors", "params": [ { - "description": "the network service provider ID of the internal load balancer element", + "description": "The zone ID to be used in the search filter.", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" - } - ], - "related": "configureInternalLoadBalancerElement", - "response": [ - { - "description": "the id of the internal load balancer element", - "name": "id", - "type": "string" }, { - "description": "Enabled/Disabled the element", - "name": "enabled", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, - {}, { - "description": "the physical network service provider id of the element", - "name": "nspid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Show removed heuristics.", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, - {} - ], - "since": "4.2.0" - }, - { - "description": "Reset api count", - "isasync": false, - "name": "resetApiLimit", - "params": [ { - "description": "the ID of the account whose limit to be reset", + "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", "length": 255, - "name": "account", - "related": "enableAccount,listAccounts,listAccounts", + "name": "type", "required": false, - "type": "uuid" + "type": "string" } ], + "related": "", "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": "When the heuristic was removed.", + "name": "removed", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Creates a VLAN IP range.", - "isasync": false, - "name": "deleteVlanIpRange", - "params": [ - { - "description": "the id of the VLAN IP range", - "length": 255, + "description": "ID of the heuristic.", "name": "id", - "related": "dedicatePublicIpRange", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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": "Provisions a host with a direct download certificate", - "isasync": false, - "name": "provisionTemplateDirectDownloadCertificate", - "params": [ - { - "description": "the id of the direct download certificate to provision", - "length": 255, - "name": "id", - "related": "uploadTemplateDirectDownloadCertificate", - "required": true, - "type": "uuid" }, { - "description": "the host to provision the certificate", - "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "When the heuristic was created.", + "name": "created", + "type": "date" }, - {}, - {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "name": "type", "type": "string" } ], - "since": "4.17.0" + "since": "4.19.0" }, { - "description": "Generates an alert", - "isasync": true, - "name": "generateAlert", + "description": "List all virtual machine instances that are assigned to a load balancer rule.", + "isasync": false, + "name": "listLoadBalancerRuleInstances", "params": [ { - "description": "Name of the alert", + "description": "List by keyword", "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "Alert description", - "length": 999, - "name": "description", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Type of the alert", + "description": "the ID of the load balancer rule", "length": 255, - "name": "type", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule", "required": true, - "type": "short" + "type": "uuid" }, { - "description": "Zone id for which alert is generated", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Pod id for which alert is generated", + "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "name": "applied", "required": false, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", "type": "boolean" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.3" - }, - { - "description": "Creates a Project role", - "isasync": false, - "name": "updateProjectRole", - "params": [ - { - "description": "creates a project role with this unique name", + "description": "true if load balancer rule VM IP information to be included; default is false", "length": 255, - "name": "name", + "name": "lbvmips", "required": false, - "type": "string" - }, - { - "description": "ID of project where role is being created", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" - }, - { - "description": "ID of the Project role", - "length": 255, - "name": "id", - "related": "updateProjectRole", - "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "The description of the Project role", + "description": "", "length": 255, - "name": "description", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], - "related": "", + "related": "listLoadBalancerRuleInstances", "response": [ + {}, + {}, { - "description": "the name of the role", - "name": "name", - "type": "string" - }, - { - "description": "the id of the project", - "name": "projectid", - "type": "string" - }, - { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "IP addresses of the vm set of lb rule", + "name": "lbvmipaddresses", + "type": "list" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -102143,393 +95668,210 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "id", - "type": "string" - }, - {}, - { - "description": "the description of the role", - "name": "description", - "type": "string" + "description": "the user vm set for lb rule", + "name": "loadbalancerruleinstance", + "type": "uservmresponse" } - ], - "since": "4.15.0" + ] }, { - "description": "Add a new Ldap Configuration", - "isasync": false, - "name": "addLdapConfiguration", + "description": "Removes a condition for VM auto scaling", + "isasync": true, + "name": "deleteCondition", "params": [ { - "description": "Hostname", + "description": "the ID of the condition.", "length": 255, - "name": "hostname", + "name": "id", + "related": "", "required": true, - "type": "string" - }, - { - "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": "port the ldap server is running on", - "name": "port", - "type": "int" - }, - { - "description": "name of the host running the ldap server", - "name": "hostname", - "type": "string" - }, - { - "description": "linked domain", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } - ], - "since": "4.2.0" + ] }, { - "description": "(Deprecated, use addLdapConfiguration) Configure the LDAP context for this site.", - "isasync": false, - "name": "ldapConfig", + "description": "Updates a physical network", + "isasync": true, + "name": "updatePhysicalNetwork", "params": [ { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", - "length": 255, - "name": "queryfilter", - "required": false, - "type": "string" - }, - { - "description": "Specify the distinguished name of a user with the search permission on the directory.", - "length": 255, - "name": "binddn", - "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": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", + "description": "Tag the physical network", "length": 255, - "name": "searchbase", + "name": "tags", "required": false, - "type": "string" + "type": "list" }, { - "description": "Enter the password for trust store.", + "description": "physical network id", "length": 255, - "name": "truststorepass", - "required": false, - "type": "string" + "name": "id", + "related": "updatePhysicalNetwork", + "required": true, + "type": "uuid" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "description": "Enabled/Disabled", "length": 255, - "name": "hostname", + "name": "state", "required": false, "type": "string" }, { - "description": "If true return current LDAP configuration", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "Enter the password.", + "description": "the VLAN for the physical network", "length": 255, - "name": "bindpass", + "name": "vlan", "required": false, "type": "string" }, { - "description": "Specify the LDAP port if required, default is 389.", - "length": 255, - "name": "port", - "required": false, - "type": "integer" - }, - { - "description": "Enter the path to trust certificates store.", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "truststore", + "name": "networkspeed", "required": false, "type": "string" } ], - "related": "ldapRemove", + "related": "", "response": [ - {}, - { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "zone name of the physical network", + "name": "zonename", "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": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "DN password", - "name": "bindpass", + "description": "the domain id of the physical network owner", + "name": "domainid", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, - { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "List vSphere storage policies", - "isasync": false, - "name": "listVsphereStoragePolicies", - "params": [ - { - "description": "ID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the physical network", + "name": "state", "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", + "description": "the speed of the physical network", + "name": "networkspeed", "type": "string" }, { - "description": "the ID of the Storage Policy", - "name": "id", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, - {}, { - "description": "the name of the Storage Policy", + "description": "name of the physical network", "name": "name", "type": "string" }, - { - "description": "the description of the Storage Policy", - "name": "description", - "type": "string" - } - ] - }, - { - "description": "Deletes a port forwarding rule", - "isasync": true, - "name": "deletePortForwardingRule", - "params": [ - { - "description": "the ID of the port forwarding rule", - "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" - } - ] + }, + {} + ], + "since": "3.0.0" }, { - "description": "moves a vpc to another physical network", + "description": "Stop a Shared FileSystem", "isasync": true, - "name": "migrateVPC", + "name": "stopSharedFileSystem", "params": [ { - "description": "the ID of the vpc", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" - }, - { - "description": "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2", + "description": "Force stop the shared filesystem.", "length": 255, - "name": "tiernetworkofferings", + "name": "forced", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "vpc offering ID", + "description": "the ID of the shared filesystem", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering", + "name": "id", + "related": "listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "required": true, "type": "uuid" - }, - { - "description": "true if previous network migration cmd failed", - "length": 255, - "name": "resume", - "required": false, - "type": "boolean" } ], - "related": "createVPC,listVPCs,updateVPC", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the owner of the VPC", - "name": "account", - "type": "string" - }, - {}, - {}, - { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the list of resource tags associated with the project", + "description": "the list of resource tags associated", "name": "tags", "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -102537,6 +95879,11 @@ "name": "customer", "type": "string" }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -102548,8 +95895,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -102558,242 +95905,405 @@ "type": "string" }, { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", "type": "boolean" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + {}, + { + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "vpc offering id the VPC is created from", - "name": "vpcofferingid", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "the name of the VPC", - "name": "name", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the list of supported services", - "name": "service", + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "the service name", - "name": "name", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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 name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "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": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - } - ], - "type": "list" - } - ], + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the 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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "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 ip address of the nic", + "name": "ipaddress", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + } + ], "type": "list" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", + "type": "string" }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" + }, + {}, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" } ], - "since": "4.11.0" + "since": "4.20.0" }, { - "description": "Deletes a global load balancer rule.", - "isasync": true, - "name": "deleteGlobalLoadBalancerRule", + "description": "create Tungsten-Fabric management network", + "isasync": false, + "name": "createTungstenFabricManagementNetwork", "params": [ { - "description": "the ID of the global load balancer rule", + "description": "the ID of pod", "length": 255, - "name": "id", - "related": "", + "name": "podid", + "related": "createManagementNetworkIpRange", "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", @@ -102804,6 +96314,11 @@ "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", @@ -102814,148 +96329,452 @@ ] }, { - "description": "update an annotation visibility.", + "description": "list Tungsten-Fabric firewall rule", "isasync": false, - "name": "updateAnnotationVisibility", + "name": "listTungstenFabricFirewallRule", "params": [ { - "description": "the annotation is visible for admins only", + "description": "the uuid of Tungsten-Fabric firewall rule", "length": 255, - "name": "adminsonly", - "required": true, - "type": "boolean" + "name": "firewallruleuuid", + "required": false, + "type": "string" }, { - "description": "the id of the annotation", + "description": "List by keyword", "length": 255, - "name": "id", - "required": true, + "name": "keyword", + "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 zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": false, "type": "string" } ], - "related": "removeAnnotation", + "related": "", "response": [ { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", + "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "Tungsten-Fabric firewall rule source network", + "name": "srcnetwork", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", + "type": "string" }, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "type": "string" }, { - "description": "the type of the annotated entity", - "name": "entitytype", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, {}, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" } - ], - "since": "4.16" + ] }, { - "description": "create Tungsten-Fabric address group", + "description": "Creates a project", "isasync": true, - "name": "createTungstenFabricAddressGroup", + "name": "createProject", "params": [ { - "description": "Tungsten-Fabric ip prefix", + "description": "user ID of the account to be assigned as owner of the project i.e., Project Admin", "length": 255, - "name": "ipprefix", + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, + "since": "4.15.0", + "type": "uuid" + }, + { + "description": "ID of the account owning a project", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "name of the project", + "length": 255, + "name": "name", "required": true, "type": "string" }, { - "description": "the ID of zone", + "description": "domain ID of the account owning a project", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, "type": "uuid" }, { - "description": "Tungsten-Fabric ip prefix length", + "description": "account who will be Admin for the project", "length": 255, - "name": "ipprefixlen", - "required": true, - "type": "integer" + "name": "account", + "required": false, + "type": "string" }, { - "description": "Tungsten-Fabric address group name", + "description": "The display text of the project, defaults to the 'name´.", "length": 255, - "name": "name", - "required": true, + "name": "displaytext", + "required": false, "type": "string" } ], "related": "", "response": [ + { + "description": "the project account name of the project", + "name": "projectaccountname", + "type": "string" + }, + { + "description": "the total volume which can be used by this project", + "name": "volumelimit", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "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 total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "Tungsten-Fabric address group uuid", - "name": "uuid", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "Tungsten-Fabric address group ip prefix length", - "name": "ipprefixlen", - "type": "int" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "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" + }, + { + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the id of the project", + "name": "id", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + {}, + { + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + {}, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the 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 virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the name of the project", + "name": "name", + "type": "string" + }, + { + "description": "the domain name where the project belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -102963,788 +96782,20416 @@ "type": "string" }, { - "description": "Tungsten-Fabric address group name", - "name": "name", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "Tungsten-Fabric address group ip prefix", - "name": "ipprefix", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" + } + ], + "since": "3.0.0" + }, + { + "description": "Assigns a certificate to a load balancer rule", + "isasync": true, + "name": "assignCertToLoadBalancer", + "params": [ + { + "description": "the ID of the certificate", + "length": 255, + "name": "certid", + "related": "", + "required": true, + "type": "uuid" }, - {} + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { - "description": "Lists BigSwitch BCF Controller devices", + "description": "Adds a Cisco Vnmc Controller", "isasync": false, - "name": "listBigSwitchBcfDevices", + "name": "addCiscoVnmcResource", "params": [ { - "description": "", + "description": "Hostname or ip address of the Cisco VNMC Controller.", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "hostname", + "required": true, + "type": "string" + }, + { + "description": "Credentials to access the Cisco VNMC Controller API", + "length": 255, + "name": "password", + "required": true, + "type": "string" }, { "description": "the Physical Network ID", "length": 255, "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": false, + "related": "", + "required": true, "type": "uuid" }, { - "description": "bigswitch BCF controller device ID", + "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, - "name": "bcfdeviceid", - "related": "listBigSwitchBcfDevices", - "required": false, - "type": "uuid" + "name": "username", + "required": true, + "type": "string" + } + ], + "related": "listCiscoVnmcResources", + "response": [ + {}, + {}, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, + {}, { - "description": "", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Marks a default zone for this account", + "isasync": true, + "name": "markDefaultZoneForAccount", + "params": [ + { + "description": "Marks the account that belongs to the specified domain.", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "description": "List by keyword", + "description": "Name of the account that is to be marked.", "length": 255, - "name": "keyword", - "required": false, + "name": "account", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": true, "type": "string" + }, + { + "description": "The Zone ID with which the account is to be marked.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", "response": [ { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "NAT support", - "name": "nat", - "type": "boolean" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, {}, { - "description": "the controller Ip address", - "name": "hostname", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "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 controller password", - "name": "password", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "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 the account can own", + "name": "cpulimit", "type": "string" }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", - "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 number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the id of the account", + "name": "id", + "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 snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "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 projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the 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 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 memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "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 primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user firstname", + "name": "firstname", + "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 name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + } + ], + "type": "list" + } + ], + "since": "4.0" + }, + { + "description": "Deletes a routing firewall rule", + "isasync": true, + "name": "deleteRoutingFirewallRule", + "params": [ + { + "description": "the ID of the Routing firewall rule", + "length": 255, + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Revokes certificate using configured CA plugin", + "isasync": true, + "name": "revokeCertificate", + "params": [ + { + "description": "The certificate serial number, as a hex value", + "length": 255, + "name": "serial", + "required": true, + "type": "string" + }, + { + "description": "The certificate CN", + "length": 255, + "name": "cn", + "required": false, + "type": "string" + }, + { + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.11.0" + }, + { + "description": "Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a \"Stopped\" state for this command to take effect.", + "isasync": false, + "name": "changeServiceForSystemVm", + "params": [ + { + "description": "the service offering ID to apply to the system vm", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "The ID of the system vm", + "length": 255, + "name": "id", + "related": "startSystemVm,changeServiceForSystemVm", + "required": true, + "type": "uuid" + }, + { + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "length": 255, + "name": "details", + "required": false, + "type": "map" + } + ], + "related": "startSystemVm", + "response": [ + { + "description": "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 link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + {}, + { + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the link local IP address for the system vm", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", + "type": "string" + }, + { + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" + }, + { + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the hostname for the system VM", + "name": "hostname", + "type": "string" + }, + { + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" + }, + { + "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobid", + "type": "string" + }, + { + "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 Pod ID for the system VM", + "name": "podid", + "type": "string" + }, + { + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" + }, + { + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" + }, + { + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" + }, + { + "description": "the ID of the system VM", + "name": "id", + "type": "string" + }, + { + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" + }, + { + "description": "the systemvm agent version", + "name": "version", + "type": "string" + }, + { + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" + }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" + }, + { + "description": "the host ID for the system VM", + "name": "hostid", + "type": "string" + }, + { + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the template name for the system VM", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" + }, + { + "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 private netmask for the system VM", + "name": "privatenetmask", + "type": "string" + }, + { + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "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": "guest vlan range", + "name": "guestvlan", + "type": "string" + }, + { + "description": "the name of the system VM", + "name": "name", + "type": "string" + }, + { + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + } + ] + }, + { + "description": "Update SIOC info", + "isasync": false, + "name": "updateSiocInfo", + "params": [ + { + "description": "Storage Pool ID", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + }, + { + "description": "Limit IOPS per GB", + "length": 255, + "name": "limitiopspergb", + "required": true, + "type": "integer" + }, + { + "description": "Shares per GB", + "length": 255, + "name": "sharespergb", + "required": true, + "type": "integer" + }, + { + "description": "Zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "Notify if IOPS above this value", + "length": 255, + "name": "iopsnotifythreshold", + "required": true, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The return message from the operation ('Success' if successful)", + "name": "msg", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ], + "since": "4.11.0" + }, + { + "description": "Deletes a vmsnapshot.", + "isasync": true, + "name": "deleteVMSnapshot", + "params": [ + { + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ], + "since": "4.2.0" + }, + { + "description": "Unmanage a guest virtual machine.", + "isasync": true, + "name": "unmanageVirtualMachine", + "params": [ + { + "description": "The ID of the virtual machine to unmanage", + "length": 255, + "name": "id", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "details of the unmanage VM operation", + "name": "details", + "type": "string" + }, + {}, + { + "description": "result of the unmanage VM operation", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.15.0" + }, + { + "description": "Starts a router.", + "isasync": true, + "name": "rebootRouter", + "params": [ + { + "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": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" + } + ], + "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "response": [ + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "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": "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": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + } + ], + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "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": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + {}, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + {}, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "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 second IPv6 DNS for the router", + "name": "ip6dns2", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "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 gateway of the nic", + "name": "gateway", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "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 first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + } + ] + }, + { + "description": "list the vm nics IP to NIC", + "isasync": false, + "name": "listNics", + "params": [ + { + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "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" + }, + { + "description": "list nic of the specific vm's network", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the nic to list IPs", + "length": 255, + "name": "nicid", + "related": "listNics", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + {}, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + {}, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "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 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 NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + } + ] + }, + { + "description": "Lists Bgp Peers.", + "isasync": false, + "name": "listBgpPeers", + "params": [ + { + "description": "UUID of the Bgp Peer.", + "length": 255, + "name": "id", + "related": "listBgpPeers,releaseBgpPeer", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of zone to which the Bgp Peer belongs to.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the domain ID which the Bgp Peer is dedicated to.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "project who which the Bgp Peer is dedicated to", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Lists only dedicated or non-dedicated Bgp Peers. If not set, lists all dedicated and non-dedicated BGP peers the domain/account can access.", + "length": 255, + "name": "isdedicated", + "required": false, + "type": "boolean" + }, + { + "description": "AS number of the Bgp Peer.", + "length": 255, + "name": "asnumber", + "required": false, + "type": "long" + } + ], + "related": "releaseBgpPeer", + "response": [ + { + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" + }, + {}, + {}, + { + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "the account of the bgp peer", + "name": "account", + "type": "string" + }, + { + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" + }, + { + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" + }, + { + "description": "password of bgp peer", + "name": "password", + "type": "string" + }, + { + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" + }, + { + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + { + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Creates an instant snapshot of a volume from existing vm snapshot.", + "isasync": true, + "name": "createSnapshotFromVMSnapshot", + "params": [ + { + "description": "the name of the snapshot", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "The ID of the VM snapshot", + "length": 255, + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", + "required": true, + "type": "uuid" + }, + { + "description": "The ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" + } + ], + "related": "copySnapshot,archiveSnapshot,listSnapshots", + "response": [ + { + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" + }, + { + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "the project name of the snapshot", + "name": "project", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + {}, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "ID of the snapshot", + "name": "id", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "name of the snapshot", + "name": "name", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + } + ], + "since": "4.10.0" + }, + { + "description": "Lists objects at specified path on an image store.", + "isasync": false, + "name": "listImageStoreObjects", + "params": [ + { + "description": "id of the image store", + "length": 255, + "name": "id", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "path to list on image store", + "length": 255, + "name": "path", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Volume ID associated with the data store object.", + "name": "volumeid", + "type": "string" + }, + { + "description": "Format of template associated with the data store object.", + "name": "format", + "type": "string" + }, + {}, + { + "description": "Template Name associated with the data store object.", + "name": "templatename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" + }, + { + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", + "type": "string" + }, + { + "description": "Size is in Bytes.", + "name": "size", + "type": "long" + }, + { + "description": "Template ID associated with the data store object.", + "name": "templateid", + "type": "string" + }, + {}, + { + "description": "Volume Name associated with the data store object.", + "name": "volumename", + "type": "string" + }, + { + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", + "type": "string" + }, + { + "description": "Name of the data store object.", + "name": "name", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Dedicates a guest vlan range to an account", + "isasync": false, + "name": "dedicateGuestVlanRange", + "params": [ + { + "description": "guest vlan range to be dedicated", + "length": 255, + "name": "vlanrange", + "required": true, + "type": "string" + }, + { + "description": "domain ID of the account owning a VLAN", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "project who will own the VLAN", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "physical network ID of the vlan", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "account who will own the VLAN", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the project id of the guest vlan range", + "name": "projectid", + "type": "string" + }, + { + "description": "the zone of the guest vlan range", + "name": "zoneid", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" + }, + { + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" + }, + { + "description": "the account of the guest VLAN range", + "name": "account", + "type": "string" + }, + {}, + { + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the guest VLAN range", + "name": "guestvlanrange", + "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 guest VLAN range", + "name": "domainid", + "type": "string" + }, + { + "description": "the project name of the guest vlan range", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the guest VLAN range", + "name": "id", + "type": "string" + } + ] + }, + { + "description": "Updates an ISO file.", + "isasync": false, + "name": "updateIso", + "params": [ + { + "description": "the name of the image file", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" + }, + { + "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", + "related": "addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" + }, + { + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "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 template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" + }, + { + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + }, + { + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "description": "the format for the image", + "length": 255, + "name": "format", + "required": false, + "type": "string" + }, + { + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the image file", + "length": 255, + "name": "id", + "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + } + ], + "related": "prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the 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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "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 name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "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": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "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": "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": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + {}, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + } + ] + }, + { + "description": "Deletes a counter for VM auto scaling", + "isasync": true, + "name": "deleteCounter", + "params": [ + { + "description": "the ID of the counter", + "length": 255, + "name": "id", + "related": "createCounter", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {} + ] + }, + { + "description": "Issues a client certificate using configured or provided CA plugin", + "isasync": true, + "name": "issueCertificate", + "params": [ + { + "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", + "length": 65535, + "name": "csr", + "required": false, + "type": "string" + }, + { + "description": "Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN", + "length": 255, + "name": "domain", + "required": false, + "type": "string" + }, + { + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "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": "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" + } + ], + "related": "listCaCertificate", + "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": "Private key for the certificate", + "name": "privatekey", + "type": "string" + }, + { + "description": "The client certificate", + "name": "certificate", + "type": "string" + }, + { + "description": "The CA certificate(s)", + "name": "cacertificates", + "type": "string" + }, + {} + ], + "since": "4.11.0" + }, + { + "description": "Creates a port forwarding rule", + "isasync": true, + "name": "createPortForwardingRule", + "params": [ + { + "description": "the starting port of port forwarding rule's private port range", + "length": 255, + "name": "privateport", + "required": true, + "type": "integer" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "length": 255, + "name": "publicendport", + "required": false, + "type": "integer" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "length": 255, + "name": "privateendport", + "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 IP address id of the port forwarding rule", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "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": "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true", + "length": 255, + "name": "openfirewall", + "required": false, + "type": "boolean" + }, + { + "description": "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": "VM guest nic secondary IP address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, + "type": "string" + }, + { + "description": "the ID of the virtual machine for the port forwarding rule", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "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).", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + } + ], + "related": "updatePortForwardingRule", + "response": [ + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "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 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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + {}, + { + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + {}, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the vm 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 protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Dedicates a zones.", + "isasync": true, + "name": "dedicateZone", + "params": [ + { + "description": "the 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 zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the ID of the Zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Account Id to which the Zone is dedicated", + "name": "accountid", + "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 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": "load template into primary storage", + "isasync": false, + "name": "prepareTemplate", + "params": [ + { + "description": "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template is prepared on all the available primary storage pools.", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "zone ID of the template to be prepared in primary storage(s).", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "template ID of the template to be prepared in primary storage(s).", + "length": 255, + "name": "templateid", + "related": "prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + } + ], + "related": "listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "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": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "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": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "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 template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "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": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "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": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "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": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "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": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + } + ] + }, + { + "description": "Lists all Buckets.", + "isasync": false, + "name": "listBuckets", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the IDs of the Buckets, mutually exclusive with id", + "length": 255, + "name": "ids", + "related": "listBuckets", + "required": false, + "type": "list" + }, + { + "description": "the name of the bucket", + "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. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the bucket", + "length": 255, + "name": "id", + "related": "listBuckets", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of the object storage pool, available to ROOT admin only", + "length": 255, + "name": "objectstorageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,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" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" + } + ], + "related": "", + "response": [ + { + "description": "Object storage provider", + "name": "provider", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the date the Bucket was created", + "name": "created", + "type": "date" + }, + { + "description": "the project name of the bucket", + "name": "project", + "type": "string" + }, + { + "description": "State of the Bucket", + "name": "state", + "type": "string" + }, + { + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", + "type": "string" + }, + { + "description": "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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "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": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", + "type": "string" + }, + { + "description": "Bucket Access Policy", + "name": "policy", + "type": "string" + }, + { + "description": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" + }, + { + "description": "the account associated with the Bucket", + "name": "account", + "type": "string" + }, + { + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Bucket Access Key", + "name": "accesskey", + "type": "string" + }, + { + "description": "the domain associated with the bucket", + "name": "domain", + "type": "string" + }, + { + "description": "Bucket Quota in GB", + "name": "quota", + "type": "integer" + }, + { + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" + }, + { + "description": "the project id of the bucket", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "Bucket URL", + "name": "url", + "type": "string" + }, + {}, + { + "description": "Bucket Secret Key", + "name": "usersecretkey", + "type": "string" + }, + { + "description": "ID of the Bucket", + "name": "id", + "type": "string" + }, + { + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the Bucket", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the domain associated with the bucket", + "name": "domainid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Stops an Internal LB vm.", + "isasync": true, + "name": "stopInternalLoadBalancerVM", + "params": [ + { + "description": "Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the internal lb vm", + "length": 255, + "name": "id", + "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" + } + ], + "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "response": [ + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "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 domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "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 name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + {}, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "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 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": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "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": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "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 ID of the nic", + "name": "id", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "Updates a security group", + "isasync": false, + "name": "updateSecurityGroup", + "params": [ + { + "description": "The new name of the security group.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "The ID of the security group.", + "length": 255, + "name": "id", + "related": "updateSecurityGroup", + "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 name of the security group", + "name": "name", + "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 domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on 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 list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag 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" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the 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", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "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 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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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": "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 ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + {} + ], + "since": "4.14.0.0" + }, + { + "description": "Creates a domain", + "isasync": false, + "name": "createDomain", + "params": [ + { + "description": "Domain UUID, required for adding domain from another Region", + "length": 255, + "name": "domainid", + "required": false, + "type": "string" + }, + { + "description": "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.", + "length": 255, + "name": "parentdomainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "creates domain with this name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Network domain for networks in the domain", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" + } + ], + "related": "listDomains,listDomains", + "response": [ + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "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 virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" + }, + {}, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" + }, + { + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + { + "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 network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + {}, + { + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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 virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the ID of the domain", + "name": "id", + "type": "string" + }, + { + "description": "the path of the domain", + "name": "path", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" + }, + { + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" + } + ] + }, + { + "description": "Adds backup image store.", + "isasync": false, + "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", + "required": false, + "type": "string" + }, + { + "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" + }, + { + "description": "the Zone ID for the image store", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "addSecondaryStorage,listSwifts", + "response": [ + { + "description": "the protocol of the image store", + "name": "protocol", + "type": "string" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" + }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + {}, + { + "description": "the 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 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": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + } + ], + "since": "4.2.0" + }, + { + "description": "Revoke a direct download certificate from hosts in a zone", + "isasync": false, + "name": "revokeTemplateDirectDownloadCertificate", + "params": [ + { + "description": "(optional) hypervisor type", + "length": 255, + "name": "hypervisor", + "required": false, + "type": "string" + }, + { + "description": "id of the certificate", + "length": 255, + "name": "id", + "related": "listTemplateDirectDownloadCertificates", + "required": false, + "type": "uuid" + }, + { + "description": "(optional) the host ID to revoke certificate", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "(optional) zone to revoke certificate", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "(optional) alias of the SSL certificate", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "provisionTemplateDirectDownloadCertificate", + "response": [ + { + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "description": "indicates the details in case of failure or host skipped", + "name": "details", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", + "type": "string" + }, + { + "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" + }, + {} + ], + "since": "4.13" + }, + { + "description": "Syncs capabilities of storage pools", + "isasync": false, + "name": "updateStorageCapabilities", + "params": [ + { + "description": "Storage pool id", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + } + ], + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "response": [ + { + "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 Pod ID of the storage pool", + "name": "podid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" + }, + { + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" + }, + { + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the storage pool type", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" + }, + { + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the ID of the storage pool", + "name": "id", + "type": "string" + }, + { + "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 host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + {}, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the 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 Zone ID of the storage pool", + "name": "zoneid", + "type": "string" + }, + { + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" + }, + { + "description": "the storage pool path", + "name": "path", + "type": "string" + } + ], + "since": "4.16.0" + }, + { + "description": "Changes ownership of a Volume from one account to another.", + "isasync": false, + "name": "assignVolume", + "params": [ + { + "description": "The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the volume to be reassigned.", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" + } + ], + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "response": [ + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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": "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" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "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": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "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": "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": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "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": "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": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "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 date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "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 write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the status of the volume", + "name": "status", + "type": "string" + } + ], + "since": "4.18.0.0" + }, + { + "description": "Deletes a userdata", + "isasync": false, + "name": "deleteUserData", + "params": [ + { + "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "an optional project for the userdata", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Userdata", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation 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.18" + }, + { + "description": "Lists all network services provided by CloudStack or for the given Provider.", + "isasync": false, + "name": "listSupportedNetworkServices", + "params": [ + { + "description": "network service provider name", + "length": 255, + "name": "provider", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "network service name to list providers and capabilities of", + "length": 255, + "name": "service", + "required": false, + "type": "string" + } + ], + "related": "", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "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" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + } + ], + "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" + } + ], + "since": "3.0.0" + }, + { + "description": "Deletes a particular ingress rule from this security group", + "isasync": true, + "name": "revokeSecurityGroupIngress", + "params": [ + { + "description": "The ID of the ingress rule", + "length": 255, + "name": "id", + "related": "authorizeSecurityGroupIngress", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Adds a network serviceProvider to a physical network", + "isasync": true, + "name": "addNetworkServiceProvider", + "params": [ + { + "description": "the name for the physical network service provider", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the Physical Network ID to add the provider to", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "the list of services to be enabled for this physical network service provider", + "length": 255, + "name": "servicelist", + "required": false, + "type": "list" + }, + { + "description": "the destination Physical Network ID to bridge to", + "length": 255, + "name": "destinationphysicalnetworkid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "listTrafficTypes", + "response": [ + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "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": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Delete site to site vpn gateway", + "isasync": true, + "name": "deleteVpnGateway", + "params": [ + { + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "updateVpnGateway", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ] + }, + { + "description": "Creates a service offering.", + "isasync": false, + "name": "createServiceOffering", + "params": [ + { + "description": "min iops of the compute offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.4", + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "byteswriteratemaxlength", + "required": false, + "type": "long" + }, + { + "description": "whether compute offering iops is custom or not", + "length": 255, + "name": "customizediops", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "burst io requests write rate of the disk offering", + "length": 255, + "name": "iopswriteratemax", + "required": false, + "type": "long" + }, + { + "description": "the ID of the containing zone(s), null for public offerings", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.13", + "type": "list" + }, + { + "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "length": 255, + "name": "systemvmtype", + "required": false, + "type": "string" + }, + { + "description": "burst bytes write rate of the disk offering", + "length": 255, + "name": "byteswriteratemax", + "required": false, + "type": "long" + }, + { + "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": "io requests read rate of the disk offering", + "length": 255, + "name": "iopsreadrate", + "required": false, + "type": "long" + }, + { + "description": "the Root disk size in GB.", + "length": 255, + "name": "rootdisksize", + "required": false, + "since": "4.15", + "type": "long" + }, + { + "description": "VMs using this offering require root volume encryption", + "length": 255, + "name": "encryptroot", + "required": false, + "since": "4.18", + "type": "boolean" + }, + { + "description": "Whether service offering size is custom or not", + "length": 255, + "name": "customized", + "required": false, + "since": "4.13", + "type": "boolean" + }, + { + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "length": 255, + "name": "hypervisorsnapshotreserve", + "required": false, + "since": "4.4", + "type": "integer" + }, + { + "description": "the storage type of the service offering. Values are local and shared.", + "length": 255, + "name": "storagetype", + "required": false, + "type": "string" + }, + { + "description": "max iops of the compute offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.4", + "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": "The maximum memory size of the custom service offering in MB", + "length": 255, + "name": "maxmemory", + "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": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", + "required": false, + "type": "long" + }, + { + "description": "the total memory of the service offering in MB", + "length": 255, + "name": "memory", + "required": false, + "type": "integer" + }, + { + "description": "the CPU number of the service offering", + "length": 255, + "name": "cpunumber", + "required": false, + "type": "integer" + }, + { + "description": "The minimum memory size of the custom service offering in MB", + "length": 255, + "name": "minmemory", + "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": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "length": 255, + "name": "storagepolicy", + "related": "", + "required": false, + "since": "4.15", + "type": "uuid" + }, + { + "description": "the ID of the disk offering to which service offering should be mapped", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "since": "4.17", + "type": "uuid" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "length": 255, + "name": "provisioningtype", + "required": false, + "type": "string" + }, + { + "description": "is this a system vm offering", + "length": 255, + "name": "issystem", + "required": false, + "type": "boolean" + }, + { + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", + "required": false, + "type": "long" + }, + { + "description": "details for planner, used to store specific parameters", + "length": 255, + "name": "serviceofferingdetails", + "required": false, + "type": "map" + }, + { + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "length": 255, + "name": "diskofferingstrictness", + "required": false, + "since": "4.17", + "type": "boolean" + }, + { + "description": "burst requests read rate of the disk offering", + "length": 255, + "name": "iopsreadratemax", + "required": false, + "type": "long" + }, + { + "description": "bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadrate", + "required": false, + "type": "long" + }, + { + "description": "For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.\nFor the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.", + "length": 255, + "name": "cpuspeed", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the containing domain(s), null for public offerings", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "list" + }, + { + "description": "restrict the CPU usage to committed service offering", + "length": 255, + "name": "limitcpuuse", + "required": false, + "type": "boolean" + }, + { + "description": "the HA for the service offering", + "length": 255, + "name": "offerha", + "required": false, + "type": "boolean" + }, + { + "description": "burst bytes read rate of the disk offering", + "length": 255, + "name": "bytesreadratemax", + "required": false, + "type": "long" + }, + { + "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": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", + "length": 255, + "name": "purgeresources", + "required": false, + "since": "4.20", + "type": "boolean" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "iopsreadratemaxlength", + "required": false, + "type": "long" + }, + { + "description": "The display text of the service offering, defaults to 'name'.", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "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 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", + "required": false, + "type": "string" + }, + { + "description": "the tags for this service offering.", + "length": 255, + "name": "tags", + "required": false, + "type": "string" + }, + { + "description": "the name of the service offering", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the host tag for this service offering.", + "length": 255, + "name": "hosttags", + "required": false, + "type": "string" + } + ], + "related": "updateServiceOffering,listServiceOfferings", + "response": [ + { + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" + }, + { + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" + }, + { + "description": "the memory in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" + }, + { + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" + }, + { + "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", + "type": "string" + }, + { + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + {}, + { + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" + }, + { + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" + }, + {}, + { + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" + }, + { + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" + }, + { + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" + }, + { + "description": "the id of the service offering", + "name": "id", + "type": "string" + }, + { + "description": "the host tag for the service offering", + "name": "hosttags", + "type": "string" + }, + { + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" + }, + { + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the tags for the service offering", + "name": "storagetags", + "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 virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" + }, + { + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" + }, + { + "description": "the name of the service offering", + "name": "name", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "state of the service offering", + "name": "state", + "type": "string" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" + }, + { + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk", + "name": "isvolatile", + "type": "boolean" + }, + { + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", + "type": "string" + }, + { + "description": "is this a system vm offering", + "name": "issystem", + "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": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "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 true if the offering is customized", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" + } + ] + }, + { + "description": "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.", + "isasync": false, + "name": "assignVirtualMachine", + "params": [ + { + "description": "an optional project for the new VM owner.", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "list of security group ids to be applied on the virtual machine. In case no security groups are provided the VM is part of the default security group.", + "length": 255, + "name": "securitygroupids", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created.", + "length": 255, + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "list" + }, + { + "description": "account name of the new VM owner.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "domain id of the new VM owner.", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "id of the VM to be moved", + "length": 255, + "name": "virtualmachineid", + "related": "assignVirtualMachine,deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the name of the 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 name of the security group", + "name": "domain", + "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 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 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": "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "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 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": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "set" + }, + { + "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 ID of the security group", + "name": "id", + "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 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 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": "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 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 value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the 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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the 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 gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + {}, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", + "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": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "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": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the 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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the 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" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the 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 name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + {}, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Lists virtual machines on a unmanaged host", + "isasync": false, + "name": "listVmsForImport", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the username for the host", + "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 host", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the host name or IP address", + "length": 255, + "name": "host", + "required": true, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "listVmwareDcVms,listUnmanagedInstances", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" + }, + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + {}, + { + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", + "type": "string" + }, + { + "description": "the 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 power state of the virtual machine", + "name": "powerstate", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the ID of the 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" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "type": "string" + }, + { + "description": "the label of the disk", + "name": "label", + "type": "string" + }, + { + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the list of nics associated with the virtual machine", + "name": "nic", + "response": [ + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the 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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" + }, + {}, + { + "description": "the ID of the 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 CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" + } + ], + "since": "4.19.0" + }, + { + "description": "configures a netscaler load balancer device", + "isasync": true, + "name": "configureNetscalerLoadBalancer", + "params": [ + { + "description": "Netscaler load balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, + "type": "uuid" + }, + { + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "length": 255, + "name": "podids", + "related": "createManagementNetworkIpRange", + "required": false, + "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": "true if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall", + "length": 255, + "name": "inline", + "required": false, + "type": "boolean" + }, + { + "description": "capacity of the device, Capacity will be interpreted as number of networks device can handle", + "length": 255, + "name": "lbdevicecapacity", + "required": false, + "type": "long" + } + ], + "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, + { + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "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 private interface of the load balancer", + "name": "privateinterface", + "type": "string" + }, + { + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" + }, + { + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "type": "string" + }, + {}, + { + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" + }, + { + "description": "the public interface of the load balancer", + "name": "publicinterface", + "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 state", + "name": "lbdevicestate", + "type": "string" + }, + { + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" + }, + { + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + } + ] + }, + { + "description": "delete Tungsten-Fabric service group", + "isasync": true, + "name": "deleteTungstenFabricServiceGroup", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric service group", + "length": 255, + "name": "servicegroupuuid", + "required": true, + "type": "string" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Adds a object storage pool", + "isasync": false, + "name": "addObjectStoragePool", + "params": [ + { + "description": "the object store provider name", + "length": 255, + "name": "provider", + "required": true, + "type": "string" + }, + { + "description": "the URL for the object store", + "length": 2048, + "name": "url", + "required": true, + "type": "string" + }, + { + "description": "the name for the object store", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "the tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the ID of the object store", + "name": "id", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the object store", + "name": "name", + "type": "string" + }, + { + "description": "the provider name of the object store", + "name": "providername", + "type": "string" + }, + {}, + { + "description": "the object store currently used size", + "name": "storageused", + "type": "long" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the url of the object store", + "name": "url", + "type": "string" + }, + { + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Deletes user from the project", + "isasync": true, + "name": "deleteUserFromProject", + "params": [ + { + "description": "ID of the project to remove the user from", + "length": 255, + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "Id of the user to be removed from the project", + "length": 255, + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Deletes a Network Service Provider.", + "isasync": true, + "name": "deleteNetworkServiceProvider", + "params": [ + { + "description": "the ID of the network service provider", + "length": 255, + "name": "id", + "related": "listTrafficTypes", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "3.0.0" + }, + { + "description": "List network devices", + "isasync": false, + "name": "listNetworkDevice", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "parameters for network device", + "length": 255, + "name": "networkdeviceparameterlist", + "required": false, + "type": "map" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "length": 255, + "name": "networkdevicetype", + "required": false, + "type": "string" + } + ], + "related": "addNetworkDevice", + "response": [ + { + "description": "the ID of the network device", + "name": "id", + "type": "string" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists Project roles in CloudStack", + "isasync": false, + "name": "listProjectRoles", + "params": [ + { + "description": "List project role by project ID.", + "length": 255, + "name": "projectid", + "related": "", + "required": true, + "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 project role by project role name.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List project role by project role ID.", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" + } + ], + "related": "updateProjectRole", + "response": [ + {}, + {}, + { + "description": "the name of the role", + "name": "name", + "type": "string" + }, + { + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, + { + "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" + }, + { + "description": "the description of the role", + "name": "description", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" + } + ], + "since": "4.15.0" + }, + { + "description": "Removes an OpenDyalight controler", + "isasync": true, + "name": "deleteOpenDaylightController", + "params": [ + { + "description": "OpenDaylight Controller ID", + "length": 255, + "name": "id", + "related": "deleteOpenDaylightController", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the username to authenticate to the controller", + "name": "username", + "type": "string" + }, + { + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ] + }, + { + "description": "Updates attributes of a template.", + "isasync": false, + "name": "updateTemplate", + "params": [ + { + "description": "true if the image supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the image file", + "length": 255, + "name": "id", + "related": "listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "description": "true if the template requires 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": "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": "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": "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 tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" + }, + { + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" + }, + { + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "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" + }, + { + "description": "the format for the image", + "length": 255, + "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": "addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", + "required": false, + "type": "string" + } + ], + "related": "listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "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": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the 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" + } + ], + "type": "set" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the 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": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + {}, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + } + ] + }, + { + "description": "Creates a VLAN IP range.", + "isasync": false, + "name": "createVlanIpRange", + "params": [ + { + "description": "true if IP range is set to system vms, false if not", + "length": 255, + "name": "forsystemvms", + "required": false, + "type": "boolean" + }, + { + "description": "the Zone ID of the VLAN IP range", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the physical network id", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the CIDR of IPv6 network, must be at least /64", + "length": 255, + "name": "ip6cidr", + "required": false, + "type": "string" + }, + { + "description": "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "true if VLAN is of Virtual type, false if Direct", + "length": 255, + "name": "forvirtualnetwork", + "required": false, + "type": "boolean" + }, + { + "description": "the ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + }, + { + "description": "true if the IP range is used for NSX resource", + "length": 255, + "name": "fornsx", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "the beginning IPv6 address in the IPv6 network range", + "length": 255, + "name": "startipv6", + "required": false, + "type": "string" + }, + { + "description": "the beginning IP address in the VLAN IP range", + "length": 255, + "name": "startip", + "required": false, + "type": "string" + }, + { + "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "length": 255, + "name": "ip6gateway", + "required": false, + "type": "string" + }, + { + "description": "the gateway of the VLAN IP range", + "length": 255, + "name": "gateway", + "required": false, + "type": "string" + }, + { + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", + "required": false, + "type": "string" + }, + { + "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "the netmask of the VLAN IP range", + "length": 255, + "name": "netmask", + "required": false, + "type": "string" + }, + { + "description": "domain ID of the account owning a VLAN", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" + }, + { + "description": "the ending IP address in the VLAN IP range", + "length": 255, + "name": "endip", + "required": false, + "type": "string" + } + ], + "related": "updateVlanIpRange", + "response": [ + { + "description": "the domain name of the VLAN IP range", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" + }, + { + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" + }, + { + "description": "the project id of the vlan range", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the vlan range", + "name": "project", + "type": "string" + }, + { + "description": "the description of the VLAN IP range", + "name": "description", + "type": "string" + }, + { + "description": "the gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the 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 end ip of the VLAN IP range", + "name": "endip", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the netmask of the VLAN IP range", + "name": "netmask", + "type": "string" + }, + { + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" + }, + { + "description": "the ID of the VLAN IP range", + "name": "id", + "type": "string" + }, + { + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" + }, + { + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" + }, + {}, + { + "description": "the account of the VLAN IP range", + "name": "account", + "type": "string" + }, + { + "description": "the cidr of the VLAN IP range", + "name": "cidr", + "type": "string" + } + ] + }, + { + "description": "Updates site to site vpn connection", + "isasync": true, + "name": "updateVpnConnection", + "params": [ + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "id of vpn connection", + "length": 255, + "name": "id", + "related": "updateVpnConnection", + "required": true, + "type": "uuid" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the project name", + "name": "project", + "type": "string" + }, + { + "description": "the connection ID", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ESP policy of the customer gateway", + "name": "esppolicy", + "type": "string" + }, + { + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" + }, + { + "description": "the project id", + "name": "projectid", + "type": "string" + }, + { + "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": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "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 public IP address", + "name": "publicip", + "type": "string" + }, + { + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" + }, + { + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" + }, + { + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" + }, + { + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", + "type": "string" + }, + { + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" + }, + { + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + {}, + { + "description": "public ip address id of the customer gateway", + "name": "gateway", + "type": "string" + } + ], + "since": "4.4" + }, + { + "description": "lists network that are using Palo Alto firewall device", + "isasync": false, + "name": "listPaloAltoFirewallNetworks", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "palo alto balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "response": [ + { + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the network's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the network's gateway", + "name": "gateway", + "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 network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "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": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the id of the network", + "name": "id", + "type": "string" + }, + { + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "the owner of the network", + "name": "account", + "type": "string" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "type": "string" + }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, + {}, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "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": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + {}, + { + "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": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "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": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "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 date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "the 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 name of the zone the network belongs to", + "name": "zonename", + "type": "string" + } + ] + }, + { + "description": "Get the path associated with the provided volume UUID", + "isasync": false, + "name": "getPathForVolume", + "params": [ + { + "description": "CloudStack Volume UUID", + "length": 255, + "name": "volumeid", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "The path field for the volume", + "name": "path", + "type": "string" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists management servers.", + "isasync": false, + "name": "listManagementServers", + "params": [ + { + "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", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the name of the management server", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the state of the management server", + "name": "state", + "type": "state" + }, + { + "description": "the version of the management server", + "name": "version", + "type": "string" + }, + { + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, + {}, + { + "description": "the IP Address for this Management Server", + "name": "serviceip", + "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 version of the java distribution running the management server process", + "name": "javaversion", + "type": "string" + }, + { + "description": "the java distribution name running the management server process", + "name": "javadistribution", + "type": "string" + }, + {}, + { + "description": "the name of the management server", + "name": "name", + "type": "string" + }, + { + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", + "type": "string" + }, + { + "description": "the last time this Management Server was started", + "name": "lastserverstart", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" + }, + { + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", + "type": "date" + } + ] + }, + { + "description": "list Tungsten-Fabric policy", + "isasync": false, + "name": "listTungstenFabricPolicyRule", + "params": [ + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric rule", + "length": 255, + "name": "ruleuuid", + "required": false, + "type": "string" + } + ], + "related": "addTungstenFabricPolicyRule", + "response": [ + { + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" + }, + {}, + { + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "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": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy action", + "name": "action", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy name", + "name": "direction", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", + "type": "string" + }, + {} + ] + }, + { + "description": "delete Tungsten-Fabric policy", + "isasync": true, + "name": "deleteTungstenFabricPolicy", + "params": [ + { + "description": "the Uuid of Tungsten-Fabric tag type", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Updates a vm group", + "isasync": false, + "name": "updateInstanceGroup", + "params": [ + { + "description": "Instance group ID", + "length": 255, + "name": "id", + "related": "updateInstanceGroup", + "required": true, + "type": "uuid" + }, + { + "description": "new instance group name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the project name of the instance group", + "name": "project", + "type": "string" + }, + { + "description": "the domain ID of the instance group", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "the domain name of the instance group", + "name": "domain", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "time and date the instance group was created", + "name": "created", + "type": "date" + }, + { + "description": "the project ID of the instance group", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the instance group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the instance group", + "name": "account", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the instance group", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "List the uploaded certificates for direct download templates", + "isasync": false, + "name": "listTemplateDirectDownloadCertificates", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the zone where certificates are uploaded", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "list direct download certificate by ID", + "length": 255, + "name": "id", + "related": "listTemplateDirectDownloadCertificates", + "required": false, + "type": "uuid" + }, + { + "description": "if set to true: include the hosts where the certificate is uploaded to", + "length": 255, + "name": "listhosts", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the direct download certificate issuer", + "name": "issuer", + "type": "string" + }, + { + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", + "type": "string" + }, + { + "description": "the zone name where the certificate is uploaded", + "name": "zonename", + "type": "string" + }, + { + "description": "the direct download certificate serial num", + "name": "serialnum", + "type": "string" + }, + {}, + { + "description": "the direct download certificate subject", + "name": "subject", + "type": "string" + }, + { + "description": "the direct download certificate issuer", + "name": "validity", + "type": "string" + }, + { + "description": "the direct download certificate id", + "name": "id", + "type": "string" + }, + {}, + { + "description": "the hypervisor of the hosts where the certificate is uploaded", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the direct download certificate alias", + "name": "alias", + "type": "string" + }, + { + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" + }, + { + "description": "the direct download certificate version", + "name": "version", + "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.17.0" + }, + { + "description": "List ucs manager", + "isasync": false, + "name": "listUcsManagers", + "params": [ + { + "description": "the zone id", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "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 ucs manager", + "length": 255, + "name": "id", + "related": "listUcsManagers", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the ID of the ucs manager", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the zone ID of ucs manager", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the name of ucs manager", + "name": "name", + "type": "string" + }, + { + "description": "the url of ucs manager", + "name": "url", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Upgrades domain router to a new service offering", + "isasync": false, + "name": "changeServiceForRouter", + "params": [ + { + "description": "The ID of the router", + "length": 255, + "name": "id", + "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" + }, + { + "description": "the service offering ID to apply to the domain router", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + } + ], + "related": "listRouters,listInternalLoadBalancerVMs", + "response": [ + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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 template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + }, + { + "description": "the name of the health check on the router", + "name": "checkname", + "type": "string" + }, + { + "description": "result of the health check", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + } + ], + "type": "list" + }, + { + "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": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + {}, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "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 type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the 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": "macaddress", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "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 account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + {}, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "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 Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "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": "Updates the volume.", + "isasync": true, + "name": "updateVolume", + "params": [ + { + "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 chain info of the volume", + "length": 255, + "name": "chaininfo", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "The path of the volume", + "length": 255, + "name": "path", + "required": false, + "type": "string" + }, + { + "description": "Set delete protection for the volume. If true, The volume will be protected from deletion. Note: If the volume is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", + "length": 255, + "name": "deleteprotection", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "new name of the volume", + "length": 255, + "name": "name", + "required": false, + "since": "4.16", + "type": "string" + }, + { + "description": "the ID of the disk volume", + "length": 255, + "name": "id", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "required": false, + "type": "uuid" + }, + { + "description": "The state of the volume", + "length": 255, + "name": "state", + "required": false, + "since": "4.3", + "type": "string" + }, + { + "description": "Destination storage pool UUID for the volume", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "since": "4.3", + "type": "uuid" + } + ], + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", + "response": [ + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "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": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "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": "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": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "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 format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the path of the volume", + "name": "path", + "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": "type of the virtual machine", + "name": "vmtype", + "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": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "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": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + {}, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + } + ] + }, + { + "description": "Lists traffic types of a given physical network.", + "isasync": false, + "name": "listTrafficTypes", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "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": "state of the network provider", + "name": "state", + "type": "string" + }, + {}, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "since": "3.0.0" + }, + { + "description": "Updates account information for the authenticated user", + "isasync": false, + "name": "updateAccount", + "params": [ + { + "description": "The UUID of the domain where the account exists", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" + }, + { + "description": "The UUID of the dynamic role to set for the account", + "length": 255, + "name": "roleid", + "related": "createRole,listRoles,updateRole", + "required": false, + "type": "uuid" + }, + { + "description": "New name for the account", + "length": 255, + "name": "newname", + "required": false, + "type": "string" + }, + { + "description": "Details for the account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" + }, + { + "description": "Current account name", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Account UUID", + "length": 255, + "name": "id", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "required": false, + "type": "uuid" + } + ], + "related": "disableAccount,enableAccount,listAccounts", + "response": [ + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "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 available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "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 state of the account", + "name": "state", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "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 available for this account", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "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 network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the ID of the role", + "name": "roleid", + "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": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "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": "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", + "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 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 account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "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": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "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) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "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) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "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 total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {}, + {}, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + } + ] + }, + { + "description": "Adds secondary storage.", + "isasync": false, + "name": "addSecondaryStorage", + "params": [ + { + "description": "the Zone ID for the secondary storage", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the URL for the secondary storage", + "length": 255, + "name": "url", + "required": true, + "type": "string" + } + ], + "related": "listSwifts", + "response": [ + { + "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 provider name of the image store", + "name": "providername", + "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 url of the image store", + "name": "url", + "type": "string" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", + "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": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + {}, + { + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.", + "isasync": false, + "name": "updateVirtualMachine", + "params": [ + { + "description": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", + "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": "", + "required": false, + "type": "list" + }, + { + "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": "Set delete protection for the virtual machine. If true, the instance will be protected from deletion. Note: If the instance is managed by another service like autoscaling groups or CKS, delete protection will be ignored.", + "length": 255, + "name": "deleteprotection", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" + }, + { + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18", + "type": "uuid" + }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "since": "4.16.0", + "type": "string" + }, + { + "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" + }, + { + "description": "user generated name", + "length": 255, + "name": "displayname", + "required": false, + "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": "group of the virtual machine", + "length": 255, + "name": "group", + "required": false, + "type": "string" + }, + { + "description": "instance name of the user vm", + "length": 255, + "name": "instancename", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "the ID of the OS type that best represents this VM.", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": false, + "type": "uuid" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "list of security group ids to be applied on the virtual machine.", + "length": 255, + "name": "securitygroupids", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", + "required": false, + "since": "4.12", + "type": "string" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "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" + } + ], + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "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 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 value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "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 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": "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 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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the 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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "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": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "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 userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + {}, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + {}, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "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 account associated with the tag", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the 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": "the ID of the 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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + {}, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "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 name of userdata used for the VM", + "name": "userdataname", + "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 netmask of the nic", + "name": "netmask", + "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "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 type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the 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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the 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 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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + } + ] + }, + { + "description": "Disables an account", + "isasync": true, + "name": "disableAccount", + "params": [ + { + "description": "If true, only lock the account; else disable the account", + "length": 255, + "name": "lock", + "required": true, + "type": "boolean" + }, + { + "description": "Account id", + "length": 255, + "name": "id", + "related": "disableAccount,enableAccount,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "Disables specified account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Disables specified account.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "enableAccount,listAccounts", + "response": [ + { + "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 secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "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 name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "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 memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the id of the account", + "name": "id", + "type": "string" + }, + { + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of virtual machines 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 total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "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 user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "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": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the account name of the user", + "name": "account", + "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 source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + }, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + } + ], + "type": "list" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Lists domains and provides detailed information for listed domains", + "isasync": false, + "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", + "required": false, + "type": "list" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "Tag for resource type to return usage", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "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": "listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "List domains by domain level.", + "length": 255, + "name": "level", + "required": false, + "type": "integer" + }, + { + "description": "flag to display the resource icon for domains", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + } + ], + "related": "listDomains", + "response": [ + { + "description": "the state of the domain", + "name": "state", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the ID of the domain", + "name": "id", + "type": "string" + }, + { + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + {}, + { + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", + "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 networks owned by domain", + "name": "networktotal", + "type": "long" + }, + { + "description": "the path of the domain", + "name": "path", + "type": "string" + }, + { + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the domain ID of the parent domain", + "name": "parentdomainid", + "type": "string" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total volume available for this domain", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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 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", + "type": "string" + }, + { + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" + }, + {}, + { + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" + }, + { + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the name of the domain", + "name": "name", + "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 available for this domain to acquire", + "name": "vmavailable", + "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) the domain can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" + } + ] + }, + { + "description": "Resets the UserData for virtual machine. The virtual machine must be in a \"Stopped\" state.", + "isasync": false, + "name": "resetUserDataForVirtualMachine", + "params": [ + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "type": "map" + }, + { + "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", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "type": "string" + }, + { + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "an optional project for the virtual machine", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + {}, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "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" + } + ], + "type": "set" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "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 allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "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": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the 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 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the 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 name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the 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" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of 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": "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": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" + }, + {}, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the project 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 domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" + } + ], + "since": "4.18.0" + }, + { + "description": "Deletes a template from the system. All virtual machines using the deleted template will not be affected.", + "isasync": true, + "name": "deleteTemplate", + "params": [ + { + "description": "Force delete a template.", + "length": 255, + "name": "forced", + "required": false, + "since": "4.9+", + "type": "boolean" + }, + { + "description": "Necessary if the template's type is system.", + "length": 255, + "name": "issystem", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, + { + "description": "the ID of the template", + "length": 255, + "name": "id", + "related": "listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of zone of the template", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "Lists all network ACLs", + "isasync": false, + "name": "listNetworkACLLists", + "params": [ + { + "description": "list network ACLs by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "Lists network ACL with the specified ID.", + "length": 255, + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", + "required": false, + "type": "uuid" + }, + { + "description": "list network ACLs by VPC ID", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "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 network ACLs by specified name", + "length": 255, + "name": "name", + "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": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "createNetworkACLList", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the ID of the ACL", + "name": "id", + "type": "string" + }, + { + "description": "the Name of the ACL", + "name": "name", + "type": "string" + }, + { + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", + "type": "string" + }, + { + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Description of the ACL", + "name": "description", + "type": "string" + }, + { + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {} + ] + }, + { + "description": "Archives (moves) a snapshot on primary storage to secondary storage", + "isasync": true, + "name": "archiveSnapshot", + "params": [ + { + "description": "The ID of the snapshot", + "length": 255, + "name": "id", + "related": "copySnapshot,archiveSnapshot,listSnapshots", + "required": true, + "type": "uuid" + } + ], + "related": "copySnapshot,listSnapshots", + "response": [ + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" + }, + { + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + {}, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "valid location types are primary and secondary.", + "name": "locationtype", + "type": "string" + }, + { + "description": "ID of the snapshot", + "name": "id", + "type": "string" + }, + { + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" + }, + { + "description": "name of the snapshot", + "name": "name", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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": "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": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", + "type": "string" + }, + { + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, + { + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" + }, + {}, + { + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" + }, + { + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", + "type": "string" + }, + { + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "description": "the project name of the snapshot", + "name": "project", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "volumeid", + "type": "string" + }, + { + "description": "the account associated with the snapshot", + "name": "account", + "type": "string" + }, + { + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Updates site to site vpn local gateway", + "isasync": true, + "name": "updateVpnGateway", + "params": [ + { + "description": "an optional field, whether to the display the vpn to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "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 customer gateway", + "length": 255, + "name": "id", + "related": "updateVpnGateway", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "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": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" + }, + { + "description": "the vpn gateway ID", + "name": "id", + "type": "string" + }, + { + "description": "the project name", + "name": "project", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the public IP address", + "name": "publicip", + "type": "string" + }, + { + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the owner", + "name": "domain", + "type": "string" + }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the vpc name of this gateway", + "name": "vpcname", + "type": "string" + } + ], + "since": "4.4" + }, + { + "description": "Releases a dedicated guest vlan range to the system", + "isasync": true, + "name": "releaseDedicatedGuestVlanRange", + "params": [ + { + "description": "the ID of the dedicated guest vlan range", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + {}, + { + "description": "the UUID of the latest async job acting on 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": "Deletes security group", + "isasync": false, + "name": "deleteSecurityGroup", + "params": [ + { + "description": "the domain ID of account owning the security group", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "The ID of the security group. Mutually exclusive with name parameter", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the account of the security group. Must be specified with domain ID", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "The ID of the security group. Mutually exclusive with id parameter", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "the project of the security group", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} + ] + }, + { + "description": "Import an unmanaged volume from a storage pool on a host into CloudStack", + "isasync": true, + "name": "importVolume", + "params": [ + { + "description": "an optional account for the volume. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the path of the volume", + "length": 255, + "name": "path", + "required": true, + "type": "string" + }, + { + "description": "the name of the volume. If not set, it will be set to the path of the volume.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "import volume for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": true, + "type": "uuid" + }, + { + "description": "import volume to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the disk offering linked to the volume", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "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": "name of the virtual machine", + "name": "vmname", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "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": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" + }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "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": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "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": "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": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project 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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "pod name of the volume", + "name": "podname", + "type": "string" + } + ], + "since": "4.19.1" + }, + { + "description": "Creates a template of a virtual machine. The virtual machine must be in a STOPPED state. A template created from this command is automatically designated as a private template visible to the account that created it.", + "isasync": true, + "name": "createTemplate", + "params": [ + { + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "since": "4.19.0", + "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 ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in", + "length": 255, + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": false, + "type": "uuid" + }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "since": "4.19.0", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "true if the template requires HVM, false otherwise", + "length": 255, + "name": "requireshvm", + "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 name of the template", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" + }, + { + "description": "true if template 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 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.", + "length": 255, + "name": "ostypeid", + "related": "addGuestOs", + "required": true, + "type": "uuid" + }, + { + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "type": "string" + }, + { + "description": "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in", + "length": 255, + "name": "snapshotid", + "related": "copySnapshot,listSnapshots", + "required": false, + "type": "uuid" + }, + { + "description": "Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal", + "length": 255, + "name": "virtualmachineid", + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "32 or 64 bit", + "length": 255, + "name": "bits", + "required": false, + "type": "integer" + }, + { + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" + }, + { + "description": "the zone for the template. Can be specified with snapshot only", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.19.0", + "type": "uuid" + }, + { + "description": "create template for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "The display text of the template, defaults to the 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + } + ], + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + {}, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag 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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the OS type for this template.", + "name": "ostypename", + "type": "string" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" + }, + { + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "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": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "true if the template is 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": "the status of the template", + "name": "status", + "type": "string" + }, + {}, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, + { + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "description": "the project name of the template", + "name": "project", + "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 ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" + } + ] + }, + { + "description": "Lists dedicated clusters.", + "isasync": false, + "name": "listDedicatedClusters", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list dedicated clusters by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the domain associated with the cluster", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the name of the account associated with the cluster. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "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 Account ID of the cluster", + "name": "accountid", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.", + "isasync": true, + "name": "uploadCustomCertificate", + "params": [ + { + "description": "The certificate to be uploaded.", + "length": 65535, + "name": "certificate", + "required": true, + "type": "string" + }, + { + "description": "A name / alias for the certificate.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "DNS domain suffix that the certificate is granted for.", + "length": 255, + "name": "domainsuffix", + "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" + }, + { + "description": "The private key for the attached certificate.", + "length": 65535, + "name": "privatekey", + "required": false, + "type": "string" + } + ], + "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": "list Tungsten-Fabric network", + "isasync": false, + "name": "listTungstenFabricNetwork", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "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" + }, + { + "description": "the uuid of Tungsten-Fabric network", + "length": 255, + "name": "networkuuid", + "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 include public network. Default value is false", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric network uuid", + "name": "uuid", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric network name", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "List traffic monitor Hosts.", + "isasync": false, + "name": "listTrafficMonitors", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "zone Id", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "addTrafficMonitor", + "response": [ + { + "description": "the zone ID of the external firewall", + "name": "zoneid", + "type": "string" + }, + { + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", + "type": "string" + }, + { + "description": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" + }, + {}, + {}, + { + "description": "the ID of the external firewall", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" + } + ] + }, + { + "description": "Releases an existing dedicated Bgp Peer.", + "isasync": true, + "name": "releaseBgpPeer", + "params": [ + { + "description": "Id of the Bgp Peer", + "length": 255, + "name": "id", + "related": "releaseBgpPeer", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", + "type": "string" + }, + {}, + {}, + { + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" + }, + { + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" + }, + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" + }, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" + }, + { + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" + }, + { + "description": "the account of the bgp peer", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" + }, + { + "description": "password of bgp peer", + "name": "password", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", + "isasync": true, + "name": "updatePortForwardingRule", + "params": [ + { + "description": "the ID of the virtual machine for the port forwarding rule", + "length": 255, + "name": "virtualmachineid", + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "VM guest nic Secondary ip address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, + "since": "4.5", + "type": "string" + }, + { + "description": "the private end port of the port forwarding rule", + "length": 255, + "name": "privateendport", + "required": false, + "type": "integer" + }, + { + "description": "the private start port of the port forwarding rule", + "length": 255, + "name": "privateport", + "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", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the port forwarding rule", + "length": 255, + "name": "id", + "related": "updatePortForwardingRule", + "required": true, + "since": "4.4", + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the current status of the latest async job acting 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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "description": "the 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 VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + {} + ] + }, + { + "description": "Acquires and associates a public IP to an account.", + "isasync": true, + "name": "associateIpAddress", + "params": [ + { + "description": "the ID of the domain to associate with this IP address", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "IP Address to be associated", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" + }, + { + "description": "the account to associate with this IP address", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the ID of the availability zone you want to acquire an public IP address from", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the VPC you want the IP address to be associated with", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "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", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "Deploy VM for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "an optional field, whether to the display the IP to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "region ID from where portable IP is to be associated.", + "length": 255, + "name": "regionid", + "related": "", + "required": false, + "type": "integer" + } + ], + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "response": [ + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" + }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + { + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the VLAN associated with the IP address", + "name": "vlanname", + "type": "string" + }, + { + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", + "type": "string" + }, + { + "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 Network where ip belongs to", + "name": "networkname", + "type": "string" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "public IP address id", + "name": "id", + "type": "string" + }, + { + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" + }, + { + "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 project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with ip address", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", + "type": "string" + }, + { + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "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": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "type": "string" + }, + {}, + { + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, + { + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" + }, + {}, + { + "description": "the domain the public IP address is associated with", + "name": "domain", + "type": "string" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "the account the public IP address is associated with", + "name": "account", + "type": "string" + }, + { + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" + } + ] + }, + { + "description": "Get the SF Volume Access Group IDs", + "isasync": false, + "name": "getSolidFireVolumeAccessGroupIds", + "params": [ + { + "description": "Cluster UUID", + "length": 255, + "name": "clusterid", + "required": true, + "type": "string" + }, + { + "description": "Storage Pool UUID", + "length": 255, + "name": "storageid", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "SolidFire Volume Access Group Ids", + "name": "solidFireVolumeAccessGroupIds", + "type": "long[]" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} + ] + }, + { + "description": "Delete site to site vpn connection", + "isasync": true, + "name": "deleteVpnConnection", + "params": [ + { + "description": "id of vpn connection", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status 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": "Lists all alerts types", + "isasync": false, + "name": "listAlertTypes", + "params": [], + "related": "listAlerts", + "response": [ + {}, + { + "description": "the id of the alert", + "name": "id", + "type": "string" + }, + { + "description": "the date and time the alert was sent", + "name": "sent", + "type": "date" + }, + { + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "description of the alert", + "name": "description", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the alert", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Creates a ACL rule in the given network (the network has to belong to VPC)", + "isasync": true, + "name": "createNetworkACL", + "params": [ + { + "description": "the traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified", + "length": 255, + "name": "traffictype", + "required": false, + "type": "string" + }, + { + "description": "The network of the VM the ACL will be created for", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "the ending port of ACL", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, + { + "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "length": 255, + "name": "cidrlist", + "required": false, + "type": "list" + }, + { + "description": "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": "A description indicating why the ACL rule is required.", + "length": 255, + "name": "reason", + "required": false, + "type": "string" + }, + { + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "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", + "required": false, + "type": "integer" + }, + { + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, + { + "description": "The number of the ACL item, its ordering", + "length": 255, + "name": "number", + "required": false, + "type": "integer" + }, + { + "description": "scl entry action, allow or deny", + "length": 255, + "name": "action", + "required": false, + "type": "string" + } + ], + "related": "updateNetworkACLItem,moveNetworkAclItem", + "response": [ + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, + { + "description": "the starting port of ACL's port range", + "name": "startport", + "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": "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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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 ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "the protocol of the ACL", + "name": "protocol", + "type": "string" + }, + { + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "description": "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": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + {} + ] + }, + { + "description": "Resets the SSH Key for virtual machine. The virtual machine must be in a \"Stopped\" state. [async]", + "isasync": true, + "name": "resetSSHKeyForVirtualMachine", + "params": [ + { + "description": "an optional project for the ssh key", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "name of the ssh key pair used to login to the virtual machine", + "length": 255, + "name": "keypair", + "required": false, + "type": "string" + }, + { + "description": "an optional account for the ssh key. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "names of the ssh key pairs to be used to login to the virtual machine", + "length": 255, + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,resetSSHKeyForVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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 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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "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 account owning the security group", + "name": "account", + "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 project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, + { + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "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 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 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" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + } + ], + "type": "set" + }, + { + "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 state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "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": "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "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 traffic type of the nic", + "name": "traffictype", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the 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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "device name", - "name": "bigswitchdevicename", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the controller username", - "name": "username", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" - } - ], - "since": "4.6.0" - }, - { - "description": "Updates a configuration.", - "isasync": false, - "name": "updateConfiguration", - "params": [ - { - "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 value of the configuration", - "length": 4096, - "name": "value", - "required": false, + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the Domain to update the parameter value for corresponding domain", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "the name of the configuration", - "length": 255, - "name": "name", - "required": true, + "description": "the project name of the vm", + "name": "project", "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 Account to update the parameter value for corresponding account", - "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the name of the parent configuration", - "name": "parent", + "description": "User VM type", + "name": "vmtype", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the component of the configuration", - "name": "component", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the value of the configuration", - "name": "id", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the category of the configuration", - "name": "category", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the value of the configuration", - "name": "value", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the configuration", - "name": "name", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the group of the configuration", - "name": "group", - "type": "string" - } - ] - }, - { - "description": "Configures HA for a host", - "isasync": true, - "name": "configureHAForHost", - "params": [ - { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "HA provider", - "length": 255, - "name": "provider", - "required": true, + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" - } - ], - "related": "disableHAForHost", - "response": [ - { - "description": "if host HA is enabled for the host", - "name": "haenable", - "type": "boolean" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, - {}, - {}, - { - "description": "operation status", - "name": "status", - "type": "boolean" - }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" - } - ], - "since": "4.11" - }, - { - "description": "Lists volume stats", - "isasync": false, - "name": "listVolumesUsageHistory", - "params": [ - { - "description": "the ID of the volume.", - "length": 255, - "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": false, - "type": "uuid" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the IDs of the volumes, mutually exclusive with id.", - "length": 255, - "name": "ids", - "related": "migrateSystemVm", - "required": false, - "type": "list" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - } - ], - "related": "", - "response": [ + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, { - "description": "the ID of the volume", - "name": "id", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, - {}, { - "description": "the name of the volume", - "name": "name", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.18.0" - }, - { - "description": "Dedicates a Public IP range to an account", - "isasync": false, - "name": "dedicatePublicIpRange", - "params": [ - { - "description": "account who will own the VLAN", - "length": 255, - "name": "account", - "required": false, + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the id of the VLAN IP range", - "length": 255, - "name": "id", - "related": "dedicatePublicIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "domain ID of the account owning a VLAN", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": true, - "type": "uuid" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "project who will own the VLAN", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the ID of the 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 name of the VLAN IP range", - "name": "domain", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the domain ID of the VLAN IP range", - "name": "domainid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the start ip of the VLAN IP range", - "name": "startip", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the network id of vlan range", - "name": "networkid", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the account of the VLAN IP range", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, {}, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" } ] }, { - "description": "Deletes an empty Bucket.", - "isasync": false, - "name": "deleteBucket", + "description": "Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated.", + "isasync": true, + "name": "deleteManagementNetworkIpRange", "params": [ { - "description": "The ID of the Bucket", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "id", - "related": "", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": true, "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Adds API permissions to a project role", - "isasync": false, - "name": "createProjectRolePermission", - "params": [ { - "description": "The rule permission, allow or deny. Default: deny.", + "description": "The vlan id the ip range sits on", "length": 255, - "name": "permission", + "name": "vlan", "required": true, "type": "string" }, { - "description": "ID of the project role", + "description": "The ending IP address.", "length": 255, - "name": "projectroleid", - "related": "", + "name": "endip", "required": true, - "type": "uuid" - }, - { - "description": "The description of the role permission", - "length": 255, - "name": "description", - "required": false, "type": "string" }, { - "description": "ID of project where project role permission is to be created", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" - }, - { - "description": "The API name or wildcard rule such as list*", + "description": "The starting IP address.", "length": 255, - "name": "rule", + "name": "startip", "required": true, "type": "string" } ], - "related": "", - "response": [ - { - "description": "the ID of the project role permission", - "name": "id", - "type": "string" - }, - { - "description": "the permission type of the api name or wildcard rule, allow/deny", - "name": "permission", - "type": "string" - }, - { - "description": "the description of the role permission", - "name": "description", - "type": "string" - }, - { - "description": "the api name or wildcard rule", - "name": "rule", - "type": "string" - }, - { - "description": "the ID of the project role to which the role permission belongs", - "name": "projectroleid", - "type": "string" - }, - { - "description": "the ID of the project", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", - "type": "string" - }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.15.0" - }, - { - "description": "lists registered service packages", - "isasync": false, - "name": "listRegisteredServicePackages", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", "response": [ { - "description": "Service Package UUID", - "name": "id", - "type": "string" - }, - {}, - { - "description": "Description of Service Package", - "name": "description", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -103752,195 +117199,104 @@ "name": "jobid", "type": "string" }, - { - "description": "Service Package Name", - "name": "name", - "type": "string" - }, {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Create a console endpoint to connect to a VM console", - "isasync": false, - "name": "createConsoleEndpoint", - "params": [ - { - "description": "(optional) extra security token, valid when the extra validation is enabled", - "length": 255, - "name": "token", - "required": false, - "type": "string" - }, - { - "description": "ID of the VM", - "length": 255, - "name": "virtualmachineid", - "related": "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the console url", - "name": "url", - "type": "string" }, { - "description": "true if the console endpoint is generated properly", + "description": "true if 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 console websocket options", - "name": "websocket", - "type": "consoleendpointwebsocketresponse" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "details in case of an error", - "name": "details", - "type": "string" - }, - {}, {} ], - "since": "4.18.0" + "since": "4.11.0.0" }, { - "description": "Updates a project role permission and/or order", + "description": "Add a supported Kubernetes version", "isasync": false, - "name": "updateProjectRolePermission", + "name": "addKubernetesSupportedVersion", "params": [ { - "description": "Project Role permission rule id", + "description": "the URL of the binaries ISO for Kubernetes supported version", "length": 255, - "name": "projectrolepermissionid", - "related": "", + "name": "url", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "ID of project where project role permission is to be updated", + "description": "the minimum number of CPUs to be set with the Kubernetes version", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "mincpunumber", "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" + "type": "integer" }, { - "description": "ID of the project role", + "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", "length": 255, - "name": "projectroleid", - "related": "", + "name": "semanticversion", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Rule permission, can be: allow or deny", + "description": "the checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "permission", + "name": "checksum", "required": false, "type": "string" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false", + "length": 255, + "name": "directdownload", + "required": false, + "since": "4.18.2", + "type": "boolean" }, - {} - ], - "since": "4.15.0" - }, - { - "description": "Enables static NAT for given IP address", - "isasync": false, - "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)", + "description": "the name of the Kubernetes supported version", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the public IP address ID for which static NAT feature is being enabled", + "description": "the minimum RAM size in MB to be set with the Kubernetes version", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "minmemory", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "VM guest NIC secondary IP address for the port forwarding rule", + "description": "the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "vmguestip", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "the ID of the virtual machine for enabling static NAT feature", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "virtualmachineid", - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, + "name": "zoneid", + "related": "listZones", + "required": false, "type": "uuid" } ], + "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, {}, { @@ -103949,806 +117305,646 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, - {} - ] - }, - { - "description": "Deletes a Zone.", - "isasync": false, - "name": "deleteZone", - "params": [ - { - "description": "the ID of the Zone", - "length": 255, - "name": "id", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", "type": "integer" }, { - "description": "the UUID 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 date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" - } - ] - }, - { - "description": "Adds user to a project", - "isasync": true, - "name": "addUserToProject", - "params": [ - { - "description": "ID of the project role", - "length": 255, - "name": "projectroleid", - "related": "", - "required": false, - "type": "uuid" }, { - "description": "Project role type to be assigned to the user - Admin/Regular", - "length": 255, - "name": "roletype", - "required": false, - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "Name of the user to be added to the project", - "length": 255, - "name": "username", - "required": true, + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "description": "ID of the project to add the user to", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" - }, - { - "description": "email ID of user to which invitation to the project is going to be sent", - "length": 255, - "name": "email", - "required": false, + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" - } - ], - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", "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.14" - }, - { - "description": "Disables HA cluster-wide", - "isasync": true, - "name": "disableHAForCluster", - "params": [ - { - "description": "ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" - } - ], - "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ], - "since": "4.11" - }, - { - "description": "delete Tungsten-Fabric firewall policy", - "isasync": true, - "name": "deleteTungstenFabricFirewallPolicy", - "params": [ - { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", - "required": true, - "type": "string" - }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" } ] }, { - "description": "Recovers a virtual machine.", + "description": "Link or unlink a userdata to a template.", "isasync": false, - "name": "recoverVirtualMachine", + "name": "linkUserDataToTemplate", "params": [ { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "response": [ - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "type": "uuid" }, { - "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 for the virtual machine", + "length": 255, + "name": "isoid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", + "length": 255, + "name": "userdatapolicy", + "required": false, "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" + } + ], + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "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 userdata linked to this template", + "name": "userdataname", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the 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", - "name": "gateway", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "tag value", + "name": "value", "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": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", + "description": "the size of the template", + "name": "size", "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, - {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "true if vm 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": "OS type id of the vm", - "name": "ostypeid", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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 name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, - {}, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the physical size of the template", + "name": "physicalsize", "type": "long" }, { - "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": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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" + } + ], + "since": "4.18.0" + }, + { + "description": "Lists load balancer rules.", + "isasync": false, + "name": "listGlobalLoadBalancerRules", + "params": [ + { + "description": "region ID", + "length": 255, + "name": "regionid", + "related": "", + "required": false, + "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the global load balancer rule", + "length": 255, + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "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": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the list of resource tags associated", + "description": "List resources by tags (key/value pairs)", + "length": 255, "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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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 name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "required": false, + "type": "map" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "updateGlobalLoadBalancerRule", + "response": [ + { + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, + {}, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" }, + {}, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "the project name of the vm", + "description": "global load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "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" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", "response": [ { - "description": "the list of resource tags associated with the rule", + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -104762,8 +117958,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -104772,604 +117968,325 @@ "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" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "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" - }, - { - "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", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the domain name of the security group", + "description": "the domain of the load balancer rule", "name": "domain", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the description of the security group", + "description": "the description of the load balancer", "name": "description", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the public ip address", + "name": "publicip", + "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": "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": "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" - }, - { - "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 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 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 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" - } - ], - "type": "set" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the ID of the affinity group", - "name": "id", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "the account owning the affinity group", + "description": "the account of the load balancer rule", "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" } ], - "type": "set" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "type": "list" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" } ] }, { - "description": "upload an existing template into the CloudStack cloud. ", - "isasync": false, - "name": "getUploadParamsForTemplate", + "description": "Release the dedication for cluster", + "isasync": true, + "name": "releaseDedicatedCluster", "params": [ { - "description": "32 or 64 bits support. 64 by default", + "description": "the ID of the Cluster", "length": 255, - "name": "bits", - "required": false, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "true if the template or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, + "description": "true if operation is executed successfully", + "name": "success", "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {} + ] + }, + { + "description": "Updates a disk offering.", + "isasync": false, + "name": "deleteDiskOffering", + "params": [ { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "description": "ID of the disk offering", "length": 255, - "name": "format", + "name": "id", + "related": "", "required": true, - "type": "string" - }, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", - "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "Upload volume/template/iso for the project", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Get Kubernetes cluster config", + "isasync": false, + "name": "getKubernetesClusterConfig", + "params": [ + { + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "ostypeid", - "related": "", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster", "required": false, "type": "uuid" - }, + } + ], + "related": "", + "response": [ { - "description": "true if this template is a featured template, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "the config data of the cluster", + "name": "configdata", + "type": "string" }, + {}, { - "description": "true if the template is available to all accounts; default is true", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the id of the container cluster", + "name": "id", "type": "string" }, { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", - "length": 255, - "name": "checksum", - "required": false, - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the volume/template/iso", - "length": 255, + "description": "Name of the container cluster", "name": "name", - "required": true, "type": "string" }, + {} + ] + }, + { + "description": "Deletes a autoscale policy.", + "isasync": true, + "name": "deleteAutoScalePolicy", + "params": [ { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "the ID of the autoscale policy", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "id", + "related": "listAutoScalePolicies", "required": true, "type": "uuid" - }, + } + ], + "response": [ { - "description": "true if the template supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if this template requires HVM", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "description": "any text associated with the success or failure", + "name": "displaytext", + "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, + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {} + ] + }, + { + "description": "Deletes a role", + "isasync": false, + "name": "deleteRole", + "params": [ { - "description": "Template details in key/value pairs.", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "the target hypervisor for the template", + "description": "ID of the role", "length": 255, - "name": "hypervisor", + "name": "id", + "related": "createRole,listRoles,updateRole", "required": true, - "type": "string" - }, - { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", - "length": 255, - "name": "deployasis", - "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "uuid" } ], - "related": "getUploadParamsForIso", "response": [ + {}, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -105377,45 +118294,29 @@ "type": "integer" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", - "type": "string" - }, - { - "description": "signature to be sent in the POST request.", - "name": "signature", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" - }, - {} + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ], - "since": "4.6.0" + "since": "4.9.0" }, { - "description": "Resets network permissions.", - "isasync": false, - "name": "resetNetworkPermissions", + "description": " delete a Cisco Nexus VSM device", + "isasync": true, + "name": "deleteCiscoNexusVSM", "params": [ { - "description": "the network ID", + "description": "Id of the Cisco Nexus 1000v VSM device to be deleted", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "required": true, "type": "uuid" } @@ -105423,419 +118324,361 @@ "response": [ {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } - ], - "since": "4.17.0" + ] }, { - "description": "update Tungsten-Fabric loadbalancer health monitor", - "isasync": true, - "name": "updateTungstenFabricLBHealthMonitor", + "description": "List internal LB VMs.", + "isasync": false, + "name": "listInternalLoadBalancerVMs", "params": [ { - "description": "loadbalancer health monitor expected code", + "description": "the Pod ID of the Internal LB VM", "length": 255, - "name": "expectedcode", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "loadbalancer health monitor retry", + "description": "the ID of the Internal LB VM", "length": 255, - "name": "retry", - "required": true, - "type": "integer" + "name": "id", + "related": "deployVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" }, { - "description": "loadbalancer health monitor interval", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "interval", - "required": true, - "type": "integer" + "name": "account", + "required": false, + "type": "string" }, { - "description": "the ID of lb rule", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "loadbalancer health monitor type", + "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", "length": 255, - "name": "type", - "required": true, - "type": "string" + "name": "fetchhealthcheckresults", + "required": false, + "since": "4.14", + "type": "boolean" }, { - "description": "loadbalancer health monitor timeout", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "timeout", - "required": true, - "type": "integer" + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "loadbalancer health monitor url path", + "description": "List Internal LB VMs by VPC", "length": 255, - "name": "urlpath", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "loadbalancer health monitor http method", + "description": "", "length": 255, - "name": "httpmethodtype", + "name": "page", "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the health monitor http method", - "name": "httpmethod", - "type": "string" - }, - { - "description": "the health monitor UUID", - "name": "uuid", - "type": "string" + "type": "integer" }, { - "description": "the health monitor interval", - "name": "interval", - "type": "int" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the health monitor type", - "name": "type", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "length": 255, + "name": "forvpc", + "required": false, + "type": "boolean" }, { - "description": "the health monitor expected code", - "name": "expectedcode", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, - {}, { - "description": "the health monitor url path", - "name": "urlpath", - "type": "string" + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the name of the Internal LB VM", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the health monitor retry", - "name": "retry", - "type": "int" - }, - { - "description": "the health monitor timeout", - "name": "timeout", - "type": "int" - }, - { - "description": "the health monitor ID", - "name": "id", - "type": "long" + "description": "the Zone ID of the Internal LB VM", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the state of the Internal LB VM", + "length": 255, + "name": "state", + "required": false, + "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - } - ] - }, - { - "description": "Release the dedication for host", - "isasync": true, - "name": "releaseDedicatedHost", - "params": [ - { - "description": "the ID of the host", + "description": "the host ID of the Internal LB VM", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, + "related": "declareHostAsDegraded,reconnectHost", + "required": false, "type": "uuid" } ], + "related": "listRouters", "response": [ - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Accepts or declines project invitation", - "isasync": true, - "name": "updateProjectInvitation", - "params": [ - { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "related": "createUser,enableUser,getUser", - "required": false, - "type": "uuid" + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" }, { - "description": "list invitations for specified account; this parameter has to be specified with domainId", - "length": 255, - "name": "token", - "required": false, + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "id of the project to join", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": true, - "type": "uuid" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "if true, accept the invitation, decline if false. True by default", - "length": 255, - "name": "accept", - "required": false, + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", "type": "boolean" }, { - "description": "account that is joining the project", - "length": 255, - "name": "account", - "required": false, + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" - } - ], - "response": [ + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "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": "any text associated with the success or failure", - "name": "displaytext", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "This is supposed to revert a volume snapshot. This command is only supported with KVM so far", - "isasync": true, - "name": "revertSnapshot", - "params": [ + }, { - "description": "The ID of the snapshot", - "length": 255, - "name": "id", - "related": "revertSnapshot,listSnapshots", - "required": true, - "type": "uuid" - } - ], - "related": "listSnapshots", - "response": [ + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "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 host ID for the router", + "name": "hostid", + "type": "string" }, - {}, { - "description": "ID of the snapshot", - "name": "id", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "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": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the project name of the snapshot", - "name": "project", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, - {}, { - "description": "name of the availability zone", - "name": "zonename", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "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 domain associated with the router", + "name": "domain", "type": "string" }, { @@ -105844,28 +118687,48 @@ "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { @@ -105874,219 +118737,383 @@ "type": "integer" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "the guest MAC address for the router", + "name": "guestmacaddress", + "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, + {}, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "id of the availability zone", + "description": "the Zone ID for the router", "name": "zoneid", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "the list of nics associated with the router", + "name": "nic", + "response": [ + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "ID of the 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 gateway of IPv6 network", + "name": "ip6gateway", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, + {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" } ] }, { - "description": "Updates a condition for VM auto scaling", - "isasync": true, - "name": "updateCondition", + "description": "Lists Cisco VNMC controllers", + "isasync": false, + "name": "listCiscoVnmcResources", "params": [ { - "description": "Value for which the Counter will be evaluated with the Operator selected.", + "description": "Cisco VNMC resource ID", "length": 255, - "name": "threshold", - "required": true, - "type": "long" + "name": "resourceid", + "related": "listCiscoVnmcResources", + "required": false, + "type": "uuid" }, { - "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", + "description": "List by keyword", "length": 255, - "name": "relationaloperator", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the condition.", + "description": "", "length": 255, - "name": "id", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", "related": "", - "required": true, + "required": false, "type": "uuid" + }, + { + "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ], - "since": "4.18.0" + }, + {}, + {}, + {}, + {}, + {}, + {} + ] }, { - "description": "Lists Regions", - "isasync": false, - "name": "listRegions", + "description": "Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail.", + "isasync": true, + "name": "executeClusterDrsPlan", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List Region by region ID.", + "description": "ID of cluster", "length": 255, "name": "id", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "List Region by region name.", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" }, { - "description": "", + "description": "Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=&migrateto[vm-index].host= Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm= indicates the UUID of the vm that you want to migrate, and host= indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>", "length": 255, - "name": "pagesize", + "name": "migrateto", "required": false, - "type": "integer" + "type": "map" } ], - "related": "addRegion", + "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Start event Id of the DRS Plan", + "name": "eventid", "type": "string" }, { - "description": "the end point of the region", - "name": "endpoint", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" + "description": "Status of DRS Plan", + "name": "status", + "type": "status" }, + {}, { - "description": "the name of the region", - "name": "name", + "description": "unique ID of the drs plan for cluster", + "name": "id", "type": "string" }, { - "description": "the ID of the region", - "name": "id", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "List of migrations", + "name": "migrations", + "type": "list" + }, + { + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" - }, {} - ] + ], + "since": "4.19.0" }, { - "description": "Configures an Internal Load Balancer element.", + "description": "Deletes a particular egress rule from this security group", "isasync": true, - "name": "configureInternalLoadBalancerElement", + "name": "revokeSecurityGroupEgress", "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", + "description": "The ID of the egress rule", "length": 255, "name": "id", - "related": "configureInternalLoadBalancerElement", + "related": "authorizeSecurityGroupIngress", "required": true, "type": "uuid" } ], - "related": "", "response": [ + {}, { - "description": "the physical network service provider id of the element", - "name": "nspid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -106095,343 +119122,339 @@ "type": "integer" }, { - "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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {} ], - "since": "4.2.0" + "since": "3.0.0" }, { - "description": "Attempts Migration of a system virtual machine to the host specified.", - "isasync": true, - "name": "migrateSystemVm", + "description": "Uploads an icon for the specified resource(s)", + "isasync": false, + "name": "uploadResourceIcon", "params": [ { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.16.0", - "type": "uuid" - }, - { - "description": "the ID of the virtual machine", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "virtualmachineid", - "related": "migrateSystemVm", + "name": "resourceids", "required": true, - "type": "uuid" + "type": "list" }, { - "description": "destination Host ID to migrate VM to", + "description": "type of the resource", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "name": "resourcetype", + "required": true, + "type": "string" }, { - "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": "Base64 string representation of the resource icon/image", + "length": 2097152, + "name": "base64image", + "required": true, + "type": "string" } ], - "related": "", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, { - "description": "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" - }, - {}, - { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.16.0.0" + }, + { + "description": "Update a supported Kubernetes version", + "isasync": false, + "name": "updateKubernetesSupportedVersion", + "params": [ { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the ID of the Kubernetes supported version", + "length": 255, + "name": "id", + "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "required": true, + "type": "uuid" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the enabled or disabled state of the Kubernetes supported version", + "length": 255, + "name": "state", + "required": true, "type": "string" - }, + } + ], + "related": "listKubernetesSupportedVersions", + "response": [ { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", - "type": "string" + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, + {}, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", - "type": "string" + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, + {}, { - "description": "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 binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" - }, + } + ] + }, + { + "description": "Deletes an existing IPv4 subnet for a zone.", + "isasync": true, + "name": "deleteIpv4SubnetForZone", + "params": [ { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "Id of the guest network IPv4 subnet", + "length": 255, + "name": "id", + "related": "dedicateIpv4SubnetForZone", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Creates a guest network IPv6 prefix.", + "isasync": true, + "name": "createGuestNetworkIpv6Prefix", + "params": [ { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "UUID of zone to which the IPv6 prefix belongs to.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "The /56 or higher IPv6 CIDR for network prefix.", + "length": 255, + "name": "prefix", + "required": true, "type": "string" - }, + } + ], + "related": "listGuestNetworkIpv6Prefixes", + "response": [ { - "description": "the Pod ID for the system VM", - "name": "podid", - "type": "string" + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the system VM", - "name": "id", - "type": "string" + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "guest IPv6 prefix", + "name": "prefix", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "id of the guest IPv6 prefix", + "name": "id", "type": "string" }, + {}, { - "description": "the last disconnected date of host", - "name": "disconnected", + "description": " date when this IPv6 prefix was created.", + "name": "created", "type": "date" }, { - "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the 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 state of the system VM", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } - ] + ], + "since": "4.17.0.0" }, { - "description": "List the counters for VM auto scaling", + "description": "Creates a role", "isasync": false, - "name": "listCounters", + "name": "createRole", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "ID of the Counter.", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", "length": 255, - "name": "id", - "related": "createCounter,listCounters", + "name": "ispublic", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Name of the counter.", + "description": "Creates a role with this unique name", "length": 255, "name": "name", - "required": false, + "required": true, "type": "string" }, { - "description": "Network provider of the counter.", + "description": "The description of the role", "length": 255, - "name": "provider", + "name": "description", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "", + "description": "ID of the role to be cloned from. Either roleid or type must be passed in", "length": 255, - "name": "pagesize", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Source of the counter.", + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, - "name": "source", + "name": "type", "required": false, "type": "string" } ], - "related": "createCounter", + "related": "listRoles,updateRole", "response": [ - {}, { - "description": "Source of the counter.", - "name": "source", + "description": "the name of the role", + "name": "name", "type": "string" }, { @@ -106440,493 +119463,490 @@ "type": "integer" }, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the type of the role", + "name": "type", "type": "string" }, {}, { - "description": "Name of the counter.", - "name": "name", + "description": "the description of the role", + "name": "description", "type": "string" }, + {}, { - "description": "Provider of the counter.", - "name": "provider", - "type": "string" + "description": "true if role is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the id of the Counter", - "name": "id", + "description": "the state of the role", + "name": "state", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the role", + "name": "id", "type": "string" } - ] + ], + "since": "4.9.0" }, { - "description": "remove Tungsten-Fabric tag", - "isasync": true, - "name": "removeTungstenFabricTag", + "description": "Upload a data disk to the cloudstack cloud.", + "isasync": false, + "name": "getUploadParamsForVolume", "params": [ { - "description": "the uuid of vms", - "length": 255, - "name": "vmuuid", - "required": false, - "type": "list" - }, - { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the name of the volume/template/iso", "length": 255, - "name": "policyuuid", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "taguuid", + "name": "format", "required": true, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "applicationpolicysetuuid", + "name": "checksum", "required": false, "type": "string" }, { - "description": "the uuid of nics", + "description": "Image store uuid", "length": 255, - "name": "nicuuid", + "name": "imagestoreuuid", "required": false, - "type": "list" + "type": "string" }, { - "description": "the ID of zone", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, "name": "zoneid", - "related": "createZone,listZones", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "the uuid of networks", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "networkuuid", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "list" + "type": "uuid" + }, + { + "description": "Upload volume/template/iso for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "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", + "related": "", + "required": false, + "type": "uuid" } ], - "related": "createTungstenFabricTag", + "related": "getUploadParamsForTemplate,getUploadParamsForIso", "response": [ { - "description": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" - }, - { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "signature to be sent in the POST request.", + "name": "signature", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" - }, { - "description": "Tungsten-Fabric tag name", - "name": "name", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" }, + {}, + {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" } - ] + ], + "since": "4.6.0" }, { - "description": "Lists all available virtual router elements.", - "isasync": false, - "name": "listVirtualRouterElements", + "description": "Updates an existing autoscale vm profile.", + "isasync": true, + "name": "updateAutoScaleVmProfile", "params": [ { - "description": "", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "page", + "name": "customid", "required": false, - "type": "integer" + "since": "4.4", + "type": "string" }, { - "description": "List by keyword", + "description": "the ID of the user used to launch and destroy the VMs", "length": 255, - "name": "keyword", + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "pagesize", + "name": "userdatadetails", "required": false, - "type": "integer" + "since": "4.18.1", + "type": "map" }, { - "description": "list virtual router elements by network service provider id", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "nspid", - "related": "listNetworkServiceProviders", + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "length": 255, + "name": "otherdeployparams", + "required": false, + "since": "4.18.0", + "type": "map" + }, + { + "description": "the template of the auto deployed virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": false, "type": "uuid" }, { - "description": "list virtual router elements by id", + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "since": "4.18.0", + "type": "string" + }, + { + "description": "the service offering of the auto deployed virtual machine", "length": 255, - "name": "id", - "related": "listVirtualRouterElements", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.18.0", "type": "uuid" }, { - "description": "list network offerings by enabled state", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", "length": 255, - "name": "enabled", + "name": "expungevmgraceperiod", "required": false, - "type": "boolean" + "type": "integer" + }, + { + "description": "the ID of the userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18.1", + "type": "uuid" + }, + { + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "length": 255, + "name": "counterparam", + "required": false, + "type": "map" + }, + { + "description": "the ID of the autoscale vm profile", + "length": 255, + "name": "id", + "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "listAutoScaleVmProfiles", "response": [ + {}, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the account associated with the provider", - "name": "account", + "description": "the project name of the vm profile", + "name": "project", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "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 time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, { - "description": "the id of the router", - "name": "id", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, - {}, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" - } - ] - }, - { - "description": "Deletes snapshot policies for the account.", - "isasync": false, - "name": "deleteSnapshotPolicies", - "params": [ - { - "description": "the Id of the snapshot policy", - "length": 255, - "name": "id", - "related": "updateSnapshotPolicy", - "required": false, - "type": "uuid" }, - { - "description": "list of snapshots policy IDs separated by comma", - "length": 255, - "name": "ids", - "related": "updateSnapshotPolicy", - "required": false, - "type": "list" - } - ], - "response": [ + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, - {}, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Lists implementors of implementor of a network traffic type or implementors of all network traffic types", - "isasync": false, - "name": "listTrafficTypeImplementors", - "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the account owning the instance group", + "name": "account", + "type": "string" }, { - "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, + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, + {}, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - } - ], - "related": "", - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { - "description": "implementor of network traffic type", - "name": "traffictypeimplementor", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, - {}, - {}, { - "description": "network traffic type", - "name": "traffictype", + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", + "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "link a cloudstack account to a group or OU in ldap", - "isasync": false, - "name": "linkAccountToLdap", + "description": "Enables an AutoScale Vm Group", + "isasync": true, + "name": "enableAutoScaleVmGroup", "params": [ { - "description": "The id of the domain that is to contain the linked account.", + "description": "the ID of the autoscale group", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "id", + "related": "enableAutoScaleVmGroup", "required": true, "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "name of the account, it will be created if it does not exist", - "length": 255, - "name": "account", - "required": true, + "description": "the domain ID of the vm group", + "name": "domainid", "type": "string" }, { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", - "length": 255, - "name": "accounttype", - "required": true, - "type": "integer" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "domain admin username in LDAP ", - "length": 255, - "name": "admin", - "required": false, - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "ldapdomain", - "required": true, - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "type of the ldap name. GROUP or OU, defaults to GROUP", - "length": 255, - "name": "type", - "required": false, + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "Domain Admin accountId that is created", - "name": "accountid", - "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": "type of the name in LDAP which is linked to the domain", - "name": "type", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "Type of the account to auto import", - "name": "accounttype", - "type": "int" + "description": "the project id of the vm group", + "name": "projectid", + "type": "string" }, { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the project name of the vm group", + "name": "project", + "type": "string" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "name", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, { - "description": "name of the group or OU in LDAP which is linked to the domain", - "name": "ldapdomain", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, - {} - ], - "since": "4.11.0" - }, - { - "description": "list the db hosts and statistics", - "isasync": false, - "name": "listDbMetrics", - "params": [], - "related": "", - "response": [ - {}, { - "description": "the number of connections to the DB", - "name": "connections", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", "type": "int" }, { - "description": "the version of the currently running DB", - "name": "version", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { - "description": "the version of the currently running DB", - "name": "versioncomment", + "description": "the private port", + "name": "privateport", "type": "string" }, - {}, { - "description": "the time these statistics were collected", - "name": "collectiontime", - "type": "date" + "description": "the domain name of the vm group", + "name": "domain", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public ip address id", + "name": "publicipid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -106934,206 +119954,178 @@ "type": "string" }, { - "description": "the uptime of the DB in seconds", - "name": "uptime", - "type": "long" - }, - { - "description": "the tls versions currently in use (accepted) by the DB", - "name": "tlsversions", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the last measured load averages on the DB", - "name": "dbloadaverages", - "type": "double[]" - }, - { - "description": "the number of queries performed on the DB", - "name": "queries", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the state of the usage server", - "name": "replicas", - "type": "string[]" + "description": "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.", + "name": "maxmembers", + "type": "int" }, { - "description": "the name of the active usage server", - "name": "hostname", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" - } - ], - "since": "4.17.0" - }, - { - "description": "Deletes an image store or Secondary Storage.", - "isasync": false, - "name": "deleteImageStore", - "params": [ - { - "description": "The image store ID or Secondary Storage ID.", - "length": 255, - "name": "id", - "related": "listSwifts,addImageStoreS3,listImageStores", - "required": true, - "type": "uuid" - } - ], - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the load balancer 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 public ip address", + "name": "publicip", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the account owning the vm group", + "name": "account", + "type": "string" }, + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the public port", + "name": "publicport", "type": "string" - }, - {} - ], - "since": "4.2.0" + } + ] }, { - "description": "Lists autoscale vm profiles.", + "description": "Lists guest network IPv6 prefixes", "isasync": false, - "name": "listAutoScaleVmProfiles", + "name": "listGuestNetworkIpv6Prefixes", "params": [ { - "description": "list profiles by service offering id", + "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the autoscale vm profile", + "description": "UUID of the IPv6 prefix.", "length": 255, "name": "id", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles", + "related": "listGuestNetworkIpv6Prefixes", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", + "type": "integer" }, { - "description": "the otherdeployparameters of the autoscale vm profile", - "length": 255, - "name": "otherdeployparams", - "required": false, + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "availability zone for the auto deployed virtual machine", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "since": "4.4", - "type": "uuid" + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" }, + {}, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of the guest IPv6 prefix", + "name": "id", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "guest IPv6 prefix", + "name": "prefix", + "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": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the templateid of the autoscale vm profile", + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" + }, + {} + ], + "since": "4.17.0" + }, + { + "description": "Updates the information about Guest OS to Hypervisor specific name mapping", + "isasync": true, + "name": "updateGuestOsMapping", + "params": [ + { + "description": "UUID of the Guest OS to hypervisor name Mapping", "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, + "name": "id", + "related": "updateGuestOsMapping", + "required": true, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Hypervisor specific name for this Guest OS", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "name": "osnameforhypervisor", + "required": true, + "type": "string" }, { - "description": "", + "description": "When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)", "length": 255, - "name": "page", + "name": "osmappingcheckenabled", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "boolean" } ], - "related": "createAutoScaleVmProfile", + "related": "", "response": [ { - "description": "the project name of the vm profile", - "name": "project", - "type": "string" - }, - { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, { @@ -107142,492 +120134,569 @@ "type": "string" }, { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, {}, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" - }, + } + ], + "since": "4.4.0" + }, + { + "description": "delete Tungsten-Fabric tag", + "isasync": true, + "name": "deleteTungstenFabricTag", + "params": [ { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the uuid of Tungsten-Fabric tag", + "length": 255, + "name": "taguuid", + "required": true, "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", - "type": "string" - }, + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" - }, - { - "description": "the account owning the instance group", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Base 64 encoded VM user data", - "name": "userdata", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} ] }, { - "description": "Disables out-of-band management for a host", - "isasync": true, - "name": "disableOutOfBandManagementForHost", + "description": "Update password of a host/pool on management server.", + "isasync": false, + "name": "updateHostPassword", "params": [ { - "description": "the ID of the host", + "description": "the cluster ID", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", - "required": true, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, "type": "uuid" - } - ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster", - "response": [ + }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "if the password should also be updated on the hosts", + "length": 255, + "name": "update_passwd_on_host", + "required": false, + "type": "boolean" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" + "description": "the host ID", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "the out-of-band management interface username", + "description": "the username for the host/cluster", + "length": 255, "name": "username", + "required": true, "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the new password for the host/cluster", + "length": 255, + "name": "password", + "required": true, "type": "string" - }, + } + ], + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" - }, {}, { - "description": "the operation result", - "name": "status", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the out-of-band management interface password", - "name": "password", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "adds a range of portable public IP's to a region", + "isasync": true, + "name": "createPortableIpRange", + "params": [ + { + "description": "the gateway for the portable IP range", + "length": 255, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", - "type": "boolean" + "description": "the beginning IP address in the portable IP range", + "length": 255, + "name": "startip", + "required": true, + "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the netmask of the portable IP range", + "length": 255, + "name": "netmask", + "required": true, "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "VLAN id, if not specified defaulted to untagged", + "length": 255, + "name": "vlan", + "required": false, "type": "string" }, - {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" - } - ], - "since": "4.9.0" - }, - { - "description": "Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'.", - "isasync": true, - "name": "cancelHostAsDegraded", - "params": [ + "description": "Id of the Region", + "length": 255, + "name": "regionid", + "related": "", + "required": true, + "type": "integer" + }, { - "description": "host ID", + "description": "the ending IP address in the portable IP range", "length": 255, - "name": "id", - "related": "cancelHostAsDegraded,reconnectHost,addBaremetalHost", + "name": "endip", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "reconnectHost,addBaremetalHost", + "related": "", "response": [ { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "portable IP range ID", + "name": "id", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, + {}, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, + {}, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" - }, - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", "type": "integer" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", + "name": "portableipaddress", "response": [ { - "description": "GPU cards present in the host", - "name": "gpugroupname", + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum 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 X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - } - ], - "type": "list" + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the account ID the portable IP address is associated with", + "name": "accountid", + "type": "string" + }, + { + "description": "the domain ID the portable IP address is associated with", + "name": "domainid", + "type": "string" + }, + { + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", + "type": "string" + }, + { + "description": "VPC the ip belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" } ], "type": "list" }, { - "description": "the ID of the host", - "name": "id", - "type": "string" - }, - { - "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", + "description": "the start ip of the portable IP range", + "name": "startip", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the end ip of the portable IP range", + "name": "endip", "type": "string" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Deletes Webhook delivery", + "isasync": false, + "name": "deleteWebhookDelivery", + "params": [ { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "The ID of the Webhook", + "length": 255, + "name": "webhookid", + "related": "createWebhook", + "required": false, + "type": "uuid" }, { - "description": "the date and time the host was created", - "name": "created", + "description": "The start date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having start date equal to or after the specified date will be considered.", + "length": 255, + "name": "startdate", + "required": false, "type": "date" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "The ID of the Webhook delivery", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "The ID of the management server", + "length": 255, + "name": "managementserverid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, + "description": "The end date range for the Webhook delivery (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"). All deliveries having end date equal to or before the specified date will be considered.", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + } + ], + "response": [ { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the admin that annotated this host", - "name": "username", + "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", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the name of the host", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Updates an existing cluster", + "isasync": false, + "name": "updateCluster", + "params": [ { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the ID of the Cluster", + "length": 255, + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "hypervisor type of the cluster", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "hypervisor type of the cluster", + "length": 255, + "name": "clustertype", + "required": false, "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "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", + "description": "the cluster name", + "length": 255, + "name": "clustername", + "required": false, "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "whether this cluster is managed by cloudstack", + "length": 255, + "name": "managedstate", + "required": false, "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "Allocation state of this cluster for allocation of new resources", + "length": 255, + "name": "allocationstate", + "required": false, "type": "string" + } + ], + "related": "addCluster", + "response": [ + { + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "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 Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "type": "string" }, + {}, { - "description": "the host version", - "name": "version", + "description": "the cluster ID", + "name": "id", "type": "string" }, + {}, { - "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", - "name": "hasenoughcapacity", - "type": "boolean" + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the Pod ID of the host", - "name": "podid", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -107635,616 +120704,700 @@ "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "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 Zone ID of the host", - "name": "zoneid", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "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 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 date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - } - ], - "since": "4.16.0.0" - }, - { - "description": "Authorizes a particular ingress rule for this security group", - "isasync": true, - "name": "authorizeSecurityGroupIngress", - "params": [ - { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", - "length": 255, - "name": "securitygroupname", - "required": false, + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "an optional account for the security group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "an optional project of the security group", - "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, - "type": "uuid" + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" }, { - "description": "type of the icmp message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" }, { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists the VMs in a VMware Datacenter", + "isasync": false, + "name": "listVmwareDcVms", + "params": [ { - "description": "error code for this icmp message", + "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": "icmpcode", + "name": "vcenter", "required": false, - "type": "integer" + "type": "string" }, { - "description": "user to security group mapping", + "description": "List by keyword", "length": 255, - "name": "usersecuritygrouplist", + "name": "keyword", "required": false, - "type": "map" + "type": "string" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", + "description": "The password for specified username.", "length": 255, - "name": "protocol", + "name": "password", "required": false, "type": "string" }, { - "description": "start port for this ingress rule", + "description": "", "length": 255, - "name": "startport", + "name": "page", "required": false, "type": "integer" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "UUID of a linked existing vCenter", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup", + "name": "existingvcenterid", + "related": "", "required": false, "type": "uuid" }, { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "The Username required to connect to resource.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "username", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "end port for this ingress rule", + "description": "", "length": 255, - "name": "endport", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, + "type": "string" } ], - "related": "", + "related": "listUnmanagedInstances", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, + {}, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", + "type": "string" }, {}, { - "description": "security group name", - "name": "securitygroupname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", "type": "integer" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the power state of the virtual machine", + "name": "powerstate", + "type": "string" + }, + { + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the list of disks associated with the virtual machine", + "name": "disk", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the label of the disk", + "name": "label", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { - "description": "tag value", - "name": "value", + "description": "the controller of the disk", + "name": "datastoretype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorename", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ID of the disk", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the controller of the disk", + "name": "controller", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" } ], "type": "set" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" }, - {}, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" + }, + { + "description": "the list of nics associated with the virtual machine", + "name": "nic", + "response": [ + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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 broadcast uri of the nic", + "name": "broadcasturi", + "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 cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + } + ], + "type": "set" } ] }, { - "description": "Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it)", - "isasync": true, - "name": "syncStoragePool", + "description": "Lists storage providers.", + "isasync": false, + "name": "listStorageProviders", "params": [ { - "description": "Storage pool id", + "description": "", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": true, - "type": "uuid" - } - ], - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", - "response": [ - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the storage pool path", - "name": "path", + "description": "the type of storage provider: either primary or image", + "length": 255, + "name": "type", + "required": true, "type": "string" - }, - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" - }, - { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, + } + ], + "related": "", + "response": [ { - "description": "the ID of the storage pool", - "name": "id", + "description": "the name of the storage provider", + "name": "name", "type": "string" }, + {}, { - "description": "the storage pool type", + "description": "the type of the storage provider: primary or image provider", "name": "type", "type": "string" }, + {}, { "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 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "List profile in ucs manager", + "isasync": false, + "name": "listUcsProfiles", + "params": [ { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the id for the ucs manager", + "length": 255, + "name": "ucsmanagerid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" - }, - {}, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the 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 hypervisor type of the storage pool", - "name": "hypervisor", + "description": "ucs profile dn", + "name": "ucsdn", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {} + ] + }, + { + "description": "This command allows the user to query the seceret and API keys for the account", + "isasync": false, + "name": "getUserKeys", + "params": [ { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, + "description": "ID of the user whose keys are required", + "length": 255, + "name": "id", + "related": "disableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the api key of the registered user", + "name": "apikey", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the secret key of the registered user", + "name": "secretkey", "type": "string" - }, - {} + } ], - "since": "4.15.1" + "since": "4.10.0" }, { - "description": "Creates a security group", - "isasync": false, - "name": "createSecurityGroup", + "description": "update global load balancer rules.", + "isasync": true, + "name": "updateGlobalLoadBalancerRule", "params": [ { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "gslbstickysessionmethodname", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "name of the security group", + "description": "load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'", "length": 255, - "name": "name", - "required": true, + "name": "gslblbmethod", + "required": false, "type": "string" }, { - "description": "Create security group for project", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, + "name": "id", + "related": "updateGlobalLoadBalancerRule", + "required": true, "type": "uuid" }, { - "description": "the description of the security group", - "length": 255, + "description": "the description of the load balancer rule", + "length": 4096, "name": "description", "required": false, "type": "string" - }, - { - "description": "an optional account for the security group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" } ], "related": "", "response": [ { - "description": "the name of the security group", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "name of the global load balancer rule", "name": "name", "type": "string" }, - {}, - {}, { - "description": "the account owning the security group", - "name": "account", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "List of load balancer rules that are part of GSLB rule", + "name": "loadbalancerrule", "response": [ { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account of the load balancer rule", "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the domain 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 UUID of the latest async job acting on this object", - "name": "jobid", - "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 egress rules associated with the security group", - "name": "egressrule", - "response": [ + }, { - "description": "the list of resource tags associated with the rule", + "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -108258,8 +121411,13 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -108273,207 +121431,231 @@ "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], - "type": "set" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the 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" + "type": "list" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "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": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "the project name of the load balancer", + "name": "project", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "the public port", + "name": "publicport", + "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" } ], - "type": "set" + "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "global load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "GSLB service type", + "name": "gslbservicetype", + "type": "string" + }, + {}, + { + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", + "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", + "type": "string" + }, + { + "description": "the account of the load balancer rule", + "name": "account", + "type": "string" + } + ] + }, + { + "description": "Lists host tags", + "isasync": false, + "name": "listHostTags", + "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" + } + ], + "related": "", + "response": [ + { + "description": "the host ID of the host tag", + "name": "hostid", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the host tag", + "name": "id", + "type": "string" + }, + { + "description": "true if the host tag is implicit", + "name": "isimplicit", + "type": "boolean" + }, + {}, + {}, + { + "description": "the name of the host tag", + "name": "name", + "type": "string" + } + ] + }, + { + "description": "Add a new guest OS type", + "isasync": true, + "name": "addGuestOs", + "params": [ + { + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "Optional name for Guest OS", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "Unique display name for Guest OS", + "length": 255, + "name": "osdisplayname", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "List network visibility and all accounts that have permissions to view this network.", - "isasync": false, - "name": "listNetworkPermissions", - "params": [ + "description": "whether this guest OS is available for end users", + "length": 255, + "name": "forDisplay", + "required": false, + "type": "boolean" + }, { - "description": "Lists network permission by network ID", + "description": "ID of Guest OS category", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "oscategoryid", + "related": "listOsCategories", "required": true, "type": "uuid" } @@ -108481,1167 +121663,1581 @@ "related": "", "response": [ { - "description": "the ID of project the network is available for", - "name": "projectid", + "description": "the name of the OS type", + "name": "name", "type": "string" }, { - "description": "the project the network is available for", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the ID of account the network is available for", - "name": "accountid", + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, - {}, { - "description": "the network ID", - "name": "networkid", + "description": "the name/description of the OS type", + "name": "description", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the account the network is available for", - "name": "account", + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" }, + {}, { - "description": "the ID of the domain to which the network belongs", - "name": "domainid", + "description": "the ID of the OS type", + "name": "id", "type": "string" }, { - "description": "the name of the domain to which the network belongs", - "name": "domain", - "type": "string" + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" } ], - "since": "4.17.0" + "since": "4.4.0" }, { - "description": "Updates Bucket properties", + "description": "add an annotation.", "isasync": false, - "name": "updateBucket", + "name": "addAnnotation", "params": [ { - "description": "The ID of the Bucket", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "Bucket Quota in GB", + "description": "The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER", "length": 255, - "name": "quota", + "name": "entitytype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Enable/Disable Bucket Versioning", + "description": "the annotation is visible for admins only", "length": 255, - "name": "versioning", + "name": "adminsonly", "required": false, + "since": "4.16.0", "type": "boolean" }, { - "description": "Bucket Access Policy", + "description": "the id of the entity to annotate", "length": 255, - "name": "policy", + "name": "entityid", "required": false, "type": "string" }, { - "description": "Enable/Disable Bucket encryption", + "description": "the annotation text", "length": 255, - "name": "encryption", + "name": "annotation", "required": false, - "type": "boolean" + "type": "string" } ], + "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the contents of the annotation", + "name": "annotation", + "type": "string" + }, + { + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + {}, + {}, + { + "description": "the type of the annotated entity", + "name": "entitytype", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the (uu)id of the annotation", + "name": "id", + "type": "string" + }, + { + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", + "type": "string" + }, + { + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" + }, + { + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", + "type": "string" + }, + { + "description": "True if the annotation is available for admins only", + "name": "adminsonly", "type": "boolean" }, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The username of the user that entered the annotation", + "name": "username", + "type": "string" + } ], - "since": "4.19.0" + "since": "4.11" }, { - "description": "Recalculate and update resource count for an account or domain.", - "isasync": false, - "name": "updateResourceCount", + "description": "Creates new NS Vpx", + "isasync": true, + "name": "deployNetscalerVpx", "params": [ { - "description": "Update resource count for a specified account. Must be used with the domainId parameter.", + "description": "the ID of the service offering for the virtual machine", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "Update resource limits for project", + "description": "The network this ip address should be associated to.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, { - "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" }, { - "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "availability zone for the virtual machine", "length": 255, - "name": "resourcetype", - "required": false, - "type": "integer" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], - "related": "", + "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter", "response": [ { - "description": "the domain name for which resource count's are updated", - "name": "domain", + "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": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", + "type": "string" }, { - "description": "the project id for which resource count's are updated", - "name": "projectid", + "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", + "name": "podids", + "type": "list" + }, + { + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "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": "name of the provider", + "name": "provider", "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", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "resource count", - "name": "resourcecount", - "type": "long" + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the account for which resource count's are updated", - "name": "account", + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, - {}, { - "description": "the domain ID for which resource count's are updated", - "name": "domainid", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, {}, { - "description": "the project name for which resource count's are updated", - "name": "project", + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" + }, + { + "description": "the private interface of the load balancer", + "name": "privateinterface", "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": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" } ] }, { - "description": "Lists site 2 site vpn gateways", + "description": "Lists the volumes of elastistor", "isasync": false, - "name": "listVpnGateways", + "name": "listElastistorVolume", "params": [ { - "description": "List by keyword", + "description": "the ID of the account", "length": 255, - "name": "keyword", - "required": false, + "name": "id", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "deduplication", + "name": "deduplication", "type": "string" }, { - "description": "id of the vpn gateway", - "length": 255, - "name": "id", - "related": "createVpnGateway,listVpnGateways", - "required": false, - "type": "uuid" + "description": "synchronization", + "name": "sync", + "type": "string" }, { - "description": "id of vpc", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", - "required": false, - "type": "uuid" + "description": "compression", + "name": "compression", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "the id of the volume", + "name": "id", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the name of the volume", + "name": "name", + "type": "string" }, + {}, + {}, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "add a baremetal pxe server", + "isasync": true, + "name": "addBaremetalPxeKickStartServer", + "params": [ + { + "description": "the Physical Network ID", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", - "required": false, + "name": "physicalnetworkid", + "related": "", + "required": true, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "URL of the external pxe device", "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" + "name": "url", + "required": true, + "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "type of pxe device", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "pxeservertype", + "required": true, + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - } - ], - "related": "createVpnGateway", - "response": [ - { - "description": "the owner", - "name": "account", + "name": "tftpdir", + "required": true, "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - {}, - { - "description": "the public IP address", - "name": "publicip", - "type": "string" + "description": "Pod Id", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the project id", - "name": "projectid", + "description": "Credentials to reach external pxe device", + "length": 255, + "name": "username", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "device id of ", + "name": "id", "type": "string" }, + {}, { - "description": "the project name", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, { - "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 domain id of the owner", - "name": "domainid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "url", + "name": "url", "type": "string" }, {} ] }, { - "description": "Lists dynamic roles in CloudStack", + "description": "Lists Nicira NVP devices", "isasync": false, - "name": "listRoles", + "name": "listNiciraNvpDevices", "params": [ { - "description": "List role by role name.", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" }, { - "description": "List role by role ID.", + "description": "", "length": 255, - "name": "id", - "related": "importRole,listRoles", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the Physical Network ID", "length": 255, - "name": "keyword", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "nicira nvp device ID", "length": 255, - "name": "page", + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "importRole", + "related": "addNiciraNvpDevice", "response": [ - {}, { - "description": "the ID of the role", - "name": "id", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "device name", + "name": "niciradevicename", "type": "string" }, {}, { - "description": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", + "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", + "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 controller Ip address", + "name": "hostname", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the description of the role", - "name": "description", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" } - ], - "since": "4.9.0" + ] }, { - "description": "list Tungsten-Fabric policy", + "description": "Lists all alerts.", "isasync": false, - "name": "listTungstenFabricPolicy", + "name": "listAlerts", "params": [ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the ID of network", + "description": "the ID of the alert", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "id", + "related": "listAlerts", "required": false, "type": "uuid" }, { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "list by alert name", "length": 255, - "name": "policyuuid", + "name": "name", "required": false, + "since": "4.3", "type": "string" }, { - "description": "the ID of ip address", + "description": "", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "list by alert type", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the date and time the alert was sent", + "name": "sent", + "type": "date" }, {}, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29", + "name": "type", + "type": "short" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the alert", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "description of the alert", + "name": "description", + "type": "string" }, { - "description": "Tungsten-Fabric policy name", + "description": "the name of the alert", "name": "name", "type": "string" }, {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} + } ] }, { - "description": "Download object at a specified path on an image store.", + "description": "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", "isasync": true, - "name": "downloadImageStoreObject", + "name": "deployVirtualMachine", "params": [ { - "description": "path to download on image store", + "description": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "path", + "name": "keypair", "required": false, "type": "string" }, { - "description": "id of the image store", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "id", - "related": "listSwifts,addImageStoreS3,listImageStores", - "required": true, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "since": "4.13", "type": "uuid" - } - ], - "related": "extractTemplate", - "response": [ + }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "the ipv6 address for default vm's network", + "length": 255, + "name": "ip6address", + "required": false, + "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an optional user generated name for the virtual machine", + "length": 255, + "name": "displayname", + "required": false, "type": "string" }, - {}, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "host name for the virtual machine", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "", - "name": "resultstring", + "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": "type of the storage", - "name": "storagetype", + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18", + "type": "map" + }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", + "length": 5120, + "name": "extraconfig", + "required": false, + "since": "4.12", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "length": 255, + "name": "bootmode", + "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com", + "length": 255, + "name": "dhcpoptionsnetworklist", + "required": false, + "type": "map" }, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" + "description": "ip to network mapping. Can't be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid", + "length": 255, + "name": "iptonetworklist", + "required": false, + "type": "map" }, { - "description": "the status of the extraction", - "name": "status", - "type": "string" + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "type": "uuid" }, - {}, { - "description": "the name of the extracted object", - "name": "name", - "type": "string" + "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the state of the extracted object", - "name": "state", - "type": "string" + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "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": "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 extracted object", - "name": "id", + "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 mode of extraction - upload or download", - "name": "extractMode", + "description": "Controls specific policies on IO", + "length": 255, + "name": "iodriverpolicy", + "required": false, "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Retrieves a cloud identifier.", - "isasync": false, - "name": "getCloudIdentifier", - "params": [ + }, { - "description": "the user ID for the cloud identifier", + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.", "length": 255, - "name": "userid", - "related": "createUser,enableUser,getUser", + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "length": 255, + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "list" + }, + { + "description": "the ID of the template for the virtual machine", + "length": 255, + "name": "templateid", + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "required": true, "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "the user ID for the cloud identifier", - "name": "userid", + "description": "Deploy vm for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the Userdata", + "length": 255, + "name": "userdataid", + "related": "", + "required": false, + "since": "4.18", + "type": "uuid" + }, + { + "description": "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", + "length": 255, + "name": "boottype", + "required": false, + "since": "4.14.0.0", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": "comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "length": 255, + "name": "securitygroupids", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "used to specify the vApp properties.", + "length": 255, + "name": "properties", + "required": false, + "since": "4.15", + "type": "map" + }, + { + "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "length": 255, + "name": "copyimagetags", + "required": false, + "since": "4.13", + "type": "boolean" + }, + { + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "length": 255, + "name": "details", + "required": false, + "since": "4.3", + "type": "map" + }, + { + "description": "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id", + "length": 255, + "name": "overridediskofferingid", + "related": "", + "required": false, + "since": "4.17", + "type": "uuid" + }, + { + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "length": 255, + "name": "size", + "required": false, + "type": "long" + }, + { + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "length": 255, + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "length": 255, + "name": "securitygroupnames", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "The number of queues for multiqueue NICs.", + "length": 255, + "name": "nicmultiqueuenumber", + "required": false, + "since": "4.18", "type": "integer" }, { - "description": "the cloud identifier", - "name": "cloudidentifier", + "description": "names of the ssh key pairs used to login to the virtual machine", + "length": 255, + "name": "keypairs", + "required": false, + "since": "4.17", + "type": "list" + }, + { + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "length": 255, + "name": "deploymentplanner", + "required": false, + "since": "4.4", "type": "string" }, - {}, { - "description": "the signed response for the cloud identifier", - "name": "signature", + "description": "an optional group for the virtual machine", + "length": 255, + "name": "group", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "length": 255, + "name": "password", + "required": false, + "since": "4.19.0.0", "type": "string" - } - ] - }, - { - "description": "Creates a load balancer stickiness policy ", - "isasync": true, - "name": "createLBStickinessPolicy", - "params": [ + }, { - "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "methodname", + "name": "displayvm", + "required": false, + "since": "4.2", + "type": "boolean" + }, + { + "description": "availability zone for the virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": true, + "type": "uuid" + }, + { + "description": "IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.", + "length": 255, + "name": "iothreadsenabled", + "required": false, + "type": "boolean" + }, + { + "description": "true if virtual machine needs to be dynamically scalable", + "length": 255, + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "description": "the ip address for default vm's network", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "param", + "name": "startvm", + "required": false, + "type": "boolean" + }, + { + "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value", + "length": 1048576, + "name": "userdata", + "required": false, + "type": "string" + }, + { + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "length": 255, + "name": "affinitygroupids", + "related": "", + "required": false, + "type": "list" + }, + { + "description": "datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter", + "length": 255, + "name": "datadiskofferinglist", "required": false, + "since": "4.11", "type": "map" }, { - "description": "the description of the load balancer stickiness policy", + "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": "description", + "name": "keyboard", "required": false, "type": "string" }, { - "description": "name of the load balancer stickiness policy", + "description": "the mac address for default vm's network", "length": 255, - "name": "name", - "required": true, + "name": "macaddress", + "required": false, "type": "string" }, { - "description": "the ID of the load balancer rule", + "description": "Enable packed virtqueues or not.", "length": 255, - "name": "lbruleid", - "related": "updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "name": "nicpackedvirtqueuesenabled", + "required": false, + "since": "4.18", + "type": "boolean" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided", "length": 255, - "name": "fordisplay", + "name": "rootdisksize", "required": false, "since": "4.4", - "type": "boolean" + "type": "long" } ], - "related": "listLBStickinessPolicies", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "response": [ { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory allocated for the virtual machine", + "name": "memory", "type": "integer" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" - }, - {}, - {}, - { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the domain of the Stickiness policy", - "name": "domain", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "the type of the affinity group", + "name": "type", + "type": "string" }, { - "description": "the LB Stickiness policy ID", + "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 Stickiness policy", - "name": "description", + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Adds a Cisco Asa 1000v appliance", - "isasync": false, - "name": "addCiscoAsa1000vResource", - "params": [ + }, { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", - "length": 255, - "name": "hostname", - "required": true, + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the Cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "Nexus port profile associated with inside interface of ASA 1000v", - "length": 255, - "name": "insideportprofile", - "required": true, + "description": "User VM type", + "name": "vmtype", "type": "string" - } - ], - "related": "", - "response": [ - {}, - {}, - {}, + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, - {}, - {}, - {}, - {} - ] - }, - { - "description": "Configures a Palo Alto firewall device", - "isasync": true, - "name": "configurePaloAltoFirewall", - "params": [ { - "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", - "length": 255, - "name": "fwdevicecapacity", - "required": false, + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "Palo Alto firewall device ID", - "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, - "type": "uuid" - } - ], - "related": "addPaloAltoFirewall,listPaloAltoFirewalls", - "response": [ - { - "description": "name of the provider", - "name": "provider", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the zone ID of the external firewall", + "description": "the ID of the availability zone for the virtual machine", "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, - {}, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, - {}, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" - } - ] - }, - { - "description": "Updates ACL item with specified ID", - "isasync": true, - "name": "updateNetworkACLItem", - "params": [ + }, { - "description": "scl entry action, allow or deny", - "length": 255, - "name": "action", - "required": false, + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", - "length": 255, - "name": "traffictype", - "required": false, + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the starting port of ACL", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "error code for this ICMP message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "A description indicating why the ACL rule is required.", - "length": 255, - "name": "reason", - "required": false, + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, + {}, + {}, { - "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": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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 type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "Id of the 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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + } + ], + "type": "set" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", - "length": 255, - "name": "protocol", - "required": false, + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the ending port of ACL", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, { - "description": "the ID of the network ACL item", - "length": 255, - "name": "id", - "related": "updateNetworkACLItem,moveNetworkAclItem", - "required": true, - "type": "uuid" + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" }, { - "description": "The network of the vm the ACL will be created for", - "length": 255, - "name": "number", - "required": false, - "type": "integer" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" - } - ], - "related": "moveNetworkAclItem", - "response": [ + }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the list of resource tags associated with the network ACLs", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -109649,100 +123245,481 @@ "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", + "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "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 name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain name of the security group", "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the tag", + "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "tag key name", - "name": "key", + "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 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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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 project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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 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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the 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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" } ], - "type": "list" + "type": "set" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, + {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - {}, - { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - }, - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, - {}, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -109750,815 +123727,649 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" - } - ] - }, - { - "description": "Moves a user to another account", - "isasync": false, - "name": "moveUser", - "params": [ - { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", - "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", - "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", - "required": false, + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "id of the user to be deleted", - "length": 255, - "name": "id", - "related": "createUser,enableUser,getUser", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, - {} - ], - "since": "4.11" + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + } + ] }, { - "description": "List routers.", + "description": "Lists all volumes.", "isasync": false, - "name": "listRouters", + "name": "listVolumes", "params": [ { - "description": "List by keyword", + "description": "list only volumes that are encrypted", "length": 255, - "name": "keyword", + "name": "isencrypted", "required": false, - "type": "string" + "since": "4.19.1", + "type": "boolean" }, { - "description": "the cluster ID of the router", + "description": "list volumes by disk offering", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "diskofferingid", + "related": "", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "the name of the router", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the name of the disk volume", "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.", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "isrecursive", + "name": "ids", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "List networks by VPC", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "clusterid", + "related": "addCluster", "required": false, "type": "uuid" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list virtual router elements by version", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "version", + "name": "displayvolume", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "list by network id", + "description": "the ID of the availability zone", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork,listBrocadeVcsDeviceNetworks", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" }, { - "description": "", + "description": "the ID of the disk volume", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the state of the router", + "description": "the ID of the virtual machine", "length": 255, - "name": "state", + "name": "virtualmachineid", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the host ID of the router", + "description": "list volumes on specified host", "length": 255, "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "related": "declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, { - "description": "the Zone ID of the router", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "uuid" + "since": "4.3", + "type": "string" }, { - "description": "the ID of the disk router", + "description": "list resources by account. Must be used with the domainId parameter.", "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,deployVnfAppliance,importUnmanagedInstance,importVm", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "if true is passed for this parameter, list only VPC routers", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "forvpc", + "name": "retrieveonlyresourcecount", "required": false, "type": "boolean" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "fetchhealthcheckresults", + "name": "isrecursive", "required": false, - "since": "4.14", "type": "boolean" }, { - "description": "the Pod ID of the router", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the pod id the disk volume belongs to", "length": 255, "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "if this parameter is passed, list only routers by health check results", + "description": "the type of disk volume", "length": 255, - "name": "healthchecksfailed", + "name": "type", "required": false, - "since": "4.16", + "type": "string" + }, + { + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "listsystemvms", + "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.19.1", "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "listall", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" } ], - "related": "destroyRouter", + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the id of the router", - "name": "id", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "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 link local netmask for the router", - "name": "linklocalnetmask", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", "type": "boolean" }, - {}, { - "description": "role of the domain router", - "name": "role", + "description": "the path of the volume", + "name": "path", "type": "string" }, - {}, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "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 vpn", + "name": "project", + "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + {}, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "description": "the traffic type of the nic", - "name": "traffictype", - "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 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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "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": "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 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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - } - ], - "type": "set" + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, + {}, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the date and time the router was created", + "description": "the date the disk volume was created", "name": "created", "type": "date" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "the first DNS for the router", - "name": "dns1", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "detailed response generated on running health check", - "name": "details", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], - "type": "list" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "type": "set" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - } - ] - }, - { - "description": "Releases host reservation.", - "isasync": true, - "name": "releaseHostReservation", - "params": [ - { - "description": "the host ID", - "length": 255, - "name": "id", - "related": "reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} - ] - }, - { - "description": "list Tungsten-Fabric vm", - "isasync": false, - "name": "listTungstenFabricVm", - "params": [ { - "description": "the uuid of Tungsten-Fabric vm", - "length": 255, - "name": "vmuuid", - "required": false, + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric nic uuid", - "name": "uuid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - {}, - { - "description": "Tungsten-Fabric vm name", - "name": "name", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { "description": "the current status of the latest async job acting on this object", @@ -110566,536 +124377,372 @@ "type": "integer" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Create site to site vpn connection", - "isasync": true, - "name": "createVpnConnection", - "params": [ - { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "id of the customer gateway", - "length": 255, - "name": "s2scustomergatewayid", - "related": "createVpnCustomerGateway", - "required": true, - "type": "uuid" - }, - { - "description": "id of the vpn gateway", - "length": 255, - "name": "s2svpngatewayid", - "related": "createVpnGateway", - "required": true, - "type": "uuid" - }, - { - "description": "connection is passive or not", - "length": 255, - "name": "passive", - "required": false, - "type": "boolean" - } - ], - "related": "", - "response": [ - {}, - { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" - }, - { - "description": "the public IP address", - "name": "publicip", - "type": "string" - }, - { - "description": "the project name", - "name": "project", - "type": "string" - }, - { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "the owner", - "name": "account", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the connection ID", - "name": "id", - "type": "string" - }, - { - "description": "the project id", - "name": "projectid", - "type": "string" - }, - { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" - }, - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" - }, - { - "description": "State of vpn connection", - "name": "state", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, - {}, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" - }, - { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", - "type": "string" - }, - { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", - "type": "string" } ] }, { - "description": "lists network that are using a brocade vcs switch", - "isasync": false, - "name": "listBrocadeVcsDeviceNetworks", + "description": "Creates a load balancer health check policy", + "isasync": true, + "name": "createLBHealthCheckPolicy", "params": [ { - "description": "List by keyword", + "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", "length": 255, - "name": "keyword", + "name": "responsetimeout", "required": false, - "type": "string" + "type": "integer" }, { - "description": "brocade vcs switch ID", + "description": "the description of the load balancer health check policy", "length": 255, - "name": "vcsdeviceid", - "related": "", - "required": true, - "type": "uuid" + "name": "description", + "required": false, + "type": "string" }, { - "description": "", + "description": "Number of consecutive health check success before declaring an instance healthy", "length": 255, - "name": "pagesize", + "name": "healthythreshold", "required": false, "type": "integer" }, { - "description": "", + "description": "HTTP ping path", "length": 255, - "name": "page", + "name": "pingpath", "required": false, - "type": "integer" - } - ], - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "response": [ - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "Number of consecutive health check failures before declaring an instance unhealthy", + "length": 255, + "name": "unhealthythreshold", + "required": false, + "type": "integer" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", - "type": "string" + "description": "Amount of time between health checks (1 sec - 20940 sec)", + "length": 255, + "name": "intervaltime", + "required": false, + "type": "integer" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", "type": "boolean" - }, + } + ], + "related": "", + "response": [ { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the account of the HealthCheck policy", + "name": "account", "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 list of services", - "name": "service", + "description": "the list of healthcheckpolicies", + "name": "healthcheckpolicy", "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": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" }, { - "description": "the service name", - "name": "name", + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" + }, + { + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "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 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": "the provider name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "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": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" } ], "type": "list" }, + {}, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "the LB rule ID", + "name": "lbruleid", "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": "the domain of the HealthCheck policy", + "name": "domain", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "4.2.0" + }, + { + "description": "Change Service offering of a Shared FileSystem", + "isasync": true, + "name": "changeSharedFileSystemServiceOffering", + "params": [ { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" + "description": "the offering to use for the shared filesystem instance", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + } + ], + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", + "response": [ + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, {}, { - "description": "the list of resource tags associated with network", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -111104,211 +124751,336 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { "description": "the project id the tag belongs to", "name": "projectid", "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" } ], - "type": "list" - }, - { - "description": "the name of the network", - "name": "name", - "type": "string" - }, - { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "type": "set" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "ID of the shared filesystem", + "name": "id", "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 domain id of the network owner", + "description": "the ID of the domain associated with the shared filesystem", "name": "domainid", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" - }, - { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" - }, - { - "description": "the network's gateway", - "name": "gateway", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "state of the network", - "name": "state", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "the owner of the network", - "name": "account", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "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 external id of the network", - "name": "externalid", - "type": "string" + "description": "the list of nics associated with the shared filesystem", + "name": "nic", + "response": [ + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "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 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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "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 type of the nic", + "name": "type", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, - {} - ] + } + ], + "since": "4.20.0" }, { - "description": "Deletes a Physical Network.", - "isasync": true, - "name": "deletePhysicalNetwork", + "description": "Locks a user account", + "isasync": false, + "name": "lockUser", "params": [ { - "description": "the ID of the Physical network", + "description": "Locks user by user ID.", "length": 255, "name": "id", - "related": "createPhysicalNetwork", + "related": "disableUser,getUser,listUsers,lockUser", "required": true, "type": "uuid" } ], + "related": "disableUser,getUser,listUsers", "response": [ + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -111316,486 +125088,506 @@ "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user state", + "name": "state", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "add Tungsten-Fabric policy rule", - "isasync": true, - "name": "addTungstenFabricPolicyRule", - "params": [ - { - "description": "Tungsten-Fabric policy rule source ip prefix length", - "length": 255, - "name": "srcipprefixlen", - "required": true, - "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination end port", - "length": 255, - "name": "destendport", - "required": true, + "description": "the account type of the user", + "name": "accounttype", "type": "integer" }, { - "description": "Tungsten-Fabric policy rule source end port", - "length": 255, - "name": "srcendport", - "required": true, - "type": "integer" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "Tungsten-Fabric policy rule source ip prefix", - "length": 255, - "name": "srcipprefix", - "required": true, + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "Tungsten-Fabric policy rule action", - "length": 255, - "name": "action", - "required": true, + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination start port", - "length": 255, - "name": "deststartport", - "required": true, - "type": "integer" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "Tungsten-Fabric policy rule source network", - "length": 255, - "name": "srcnetwork", - "required": true, + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "Tungsten-Fabric policy rule source start port", - "length": 255, - "name": "srcstartport", - "required": true, - "type": "integer" + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "Tungsten-Fabric policy rule direction", - "length": 255, - "name": "direction", - "required": true, + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", - "length": 255, - "name": "policyuuid", - "required": true, + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix length", - "length": 255, - "name": "destipprefixlen", - "required": true, - "type": "integer" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "Tungsten-Fabric policy rule protocol", - "length": 255, - "name": "protocol", - "required": true, + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination network", - "length": 255, - "name": "destnetwork", - "required": true, + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix", - "length": 255, - "name": "destipprefix", - "required": true, + "description": "the user email address", + "name": "email", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "Tungsten-Fabric policy action", - "name": "action", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" + } + ] + }, + { + "description": "Checks if the Cloudian Connector is enabled", + "isasync": false, + "name": "cloudianIsEnabled", + "params": [], + "related": "", + "response": [ + {}, + {}, + { + "description": "the Cloudian connector enabled state", + "name": "enabled", + "type": "boolean" }, { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", + "description": "the Cloudian Management Console base URL", + "name": "url", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", - "type": "int" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, + } + ], + "since": "4.11.0" + }, + { + "description": "Creates a network", + "isasync": false, + "name": "createNetwork", + "params": [ { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" + "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": "subdomainaccess", + "required": false, + "type": "boolean" }, - {}, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", - "type": "string" + "description": "Ids of the Bgp Peer for the network", + "length": 255, + "name": "bgppeerids", + "related": "", + "required": false, + "since": "4.20.0", + "type": "list" }, - {}, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", + "description": "the second IPv6 DNS for the network", + "length": 255, + "name": "ip6dns2", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" + "description": "domain ID of the account owning a network. If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If account is not specified, but acltype is Domain, the network will be created for the specified domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "the ID or VID of the network", + "length": 255, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", + "description": "the beginning IP address in the network IP range", + "length": 255, + "name": "startip", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix", - "name": "destipprefix", - "type": "string" + "description": "the AS Number of the network", + "length": 255, + "name": "asnumber", + "required": false, + "since": "4.20.0", + "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "length": 255, + "name": "endip", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", - "type": "int" + "description": "the second IPv4 DNS for the network", + "length": 255, + "name": "dns2", + "required": false, + "since": "4.18.0", + "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "direction", + "description": "the isolated private VLAN type for this network", + "length": 255, + "name": "isolatedpvlantype", + "required": false, "type": "string" - } - ] - }, - { - "description": "Dedicates a host.", - "isasync": true, - "name": "dedicateHost", - "params": [ + }, { - "description": "the ID of the host to update", + "description": "the zone ID for the network", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" }, { - "description": "the name of the account which needs dedication. Must be used with domainId.", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "account", + "name": "publicmtu", "required": false, - "type": "string" + "since": "4.18.0", + "type": "integer" }, { - "description": "the ID of the containing domain", + "description": "the network offering ID", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "networkofferingid", + "related": "listNetworkOfferings", "required": true, "type": "uuid" - } - ], - "related": "listDedicatedHosts", - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Network ACL ID associated for the network", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList", + "required": false, + "type": "uuid" }, { - "description": "the domain ID of the host", - "name": "domainid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "length": 255, + "name": "tungstenvirtualrouteruuid", + "required": false, "type": "string" }, - {}, - {}, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "network domain", + "length": 255, + "name": "networkdomain", + "required": false, "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "the first IPv4 DNS for the network", + "length": 255, + "name": "dns1", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "the VPC network belongs to", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" }, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "the name of the network", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the CIDR of IPv6 network, must be at least /64", + "length": 255, + "name": "ip6cidr", + "required": false, "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Removes vpn user", - "isasync": true, - "name": "removeVpnUser", - "params": [ + "description": "The network this network is associated to. only available if create a Shared network", + "length": 255, + "name": "associatednetworkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "since": "4.17.0", + "type": "uuid" + }, { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "an optional project for the network", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "username for the vpn user", + "description": "the gateway of the IPv6 network. Required for Shared networks", "length": 255, - "name": "username", - "required": true, + "name": "ip6gateway", + "required": false, "type": "string" }, { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "description": "the physical network ID the network belongs to", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "physicalnetworkid", + "related": "", "required": false, "type": "uuid" }, { - "description": "remove vpn user from the project", + "description": "Account that will own the network. Account should be under the selected domain", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "account", "required": false, - "type": "uuid" - } - ], - "response": [ + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display text of the network", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "MTU to be configured on the network VR's private interface(s)", + "length": 255, + "name": "privatemtu", + "required": false, + "since": "4.18.0", + "type": "integer" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the beginning IPv6 address in the IPv6 network range", + "length": 255, + "name": "startipv6", + "required": false, "type": "string" - } - ] - }, - { - "description": "Adds the GloboDNS external host", - "isasync": true, - "name": "addGloboDnsHost", - "params": [ + }, { - "description": "Username for GloboDNS", + "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "cidrsize", + "required": false, + "since": "4.20.0", + "type": "integer" }, { - "description": "Password for GloboDNS", + "description": "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,", "length": 255, - "name": "password", - "required": true, + "name": "sourcenatipaddress", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "the Physical Network ID", + "description": "IPV6 address to be assigned to a router in a shared network", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "name": "routeripv6", + "required": false, + "since": "4.16", + "type": "string" }, { - "description": "GloboDNS url", + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "url", - "required": true, + "name": "gateway", + "required": false, "type": "string" - } - ], - "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the isolated private VLAN for this network", + "length": 255, + "name": "isolatedpvlan", + "required": false, "type": "string" }, - {} - ], - "since": "4.5.0" - }, - { - "description": "List public IP addresses in quarantine.", - "isasync": false, - "name": "listQuarantinedIps", - "params": [ { - "description": "List by keyword", + "description": "the first IPv6 DNS for the network", "length": 255, - "name": "keyword", + "name": "ip6dns1", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "", + "description": "ID of the network in an external system.", "length": 255, - "name": "page", + "name": "externalid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "IPV4 address to be assigned to a router in a shared network", "length": 255, - "name": "pagesize", + "name": "routerip", "required": false, - "type": "integer" + "since": "4.16", + "type": "string" }, { - "description": "Show IPs that are no longer in quarantine.", + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", "length": 255, - "name": "showinactive", + "name": "bypassvlanoverlapcheck", "required": false, "type": "boolean" }, { - "description": "Show IPs removed from quarantine.", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "showremoved", + "name": "displaynetwork", "required": false, "type": "boolean" } ], - "related": "updateQuarantinedIp", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ - {}, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "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": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "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 default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { @@ -111803,628 +125595,734 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "ID of the quarantine process.", - "name": "id", + "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": "End date for the quarantine.", - "name": "enddate", - "type": "date" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "since": "4.19" - }, - { - "description": "Logs out the user", - "isasync": false, - "name": "logout", - "params": [], - "related": "", - "response": [ - {}, + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the 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": "Response description", - "name": "description", + "description": "the network's netmask", + "name": "netmask", "type": "string" - } - ] - }, - { - "description": "Deletes a load balancer health check policy.", - "isasync": true, - "name": "deleteLBHealthCheckPolicy", - "params": [ - { - "description": "the ID of the load balancer health check policy", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" }, - {} - ], - "since": "4.2.0" - }, - { - "description": "Imports a role based on provided map of rule permissions", - "isasync": false, - "name": "importRole", - "params": [ { - "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 internet protocol of network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", - "length": 255, - "name": "type", - "required": false, + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "length": 255, - "name": "ispublic", - "required": false, + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "The description of the role", - "length": 255, - "name": "description", - "required": false, - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing", - "length": 255, - "name": "rules", - "required": true, - "type": "map" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "Creates a role with this unique name", - "length": 255, - "name": "name", - "required": true, + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "true if role is default, false otherwise", - "name": "isdefault", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "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 ID of the role", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the type of the role", - "name": "type", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the name of the role", - "name": "name", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", "type": "string" }, { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", - "name": "ispublic", - "type": "boolean" - } - ], - "since": "4.15.0" - }, - { - "description": "List Swift.", - "isasync": false, - "name": "listSwifts", - "params": [ + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, { - "description": "the id of the swift", - "length": 255, - "name": "id", - "required": false, - "type": "long" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - } - ], - "related": "addImageStoreS3,listImageStores", - "response": [ + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, { - "description": "the ID of the image store", - "name": "id", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", + "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + {}, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the name of the image store", - "name": "name", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Disables HA for a host", - "isasync": true, - "name": "disableHAForHost", - "params": [ + }, { - "description": "ID of the host", - "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, + "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": "network offering id the network is created from", + "name": "networkofferingid", + "type": "string" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "type": "boolean" }, { - "description": "the host HA provider", - "name": "haprovider", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "operation status", - "name": "status", - "type": "boolean" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, - {}, { - "description": "the HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.11" - }, - { - "description": "Enables out-of-band management for a host", - "isasync": true, - "name": "enableOutOfBandManagementForHost", - "params": [ - { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "related": "disableOutOfBandManagementForCluster", - "response": [ + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the name of the network", + "name": "name", "type": "string" }, - {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the operation result", - "name": "status", - "type": "boolean" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, - {}, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the out-of-band management interface address", - "name": "address", + "description": "the project name of the address", + "name": "project", "type": "string" }, + {}, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the out-of-band management interface username", - "name": "username", - "type": "string" + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The external id of the network", + "name": "externalid", + "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" } - ], - "since": "4.9.0" + ] }, { - "description": "Deletes a service offering.", + "description": "Lists all available network offerings.", "isasync": false, - "name": "deleteServiceOffering", + "name": "listNetworkOfferings", "params": [ { - "description": "the ID of the service offering", + "description": "true if offering has tags specified", "length": 255, - "name": "id", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - } - ], - "response": [ + "name": "istagged", + "required": false, + "type": "boolean" + }, { - "description": "any text associated with the success or failure", + "description": "list network offerings by display text", + "length": 255, "name": "displaytext", + "required": false, "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "list network offerings available for network creation in specific domain", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "since": "4.13", + "type": "uuid" + }, + { + "description": "list network offerings by state", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, + { + "description": "list network offerings by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "list network offerings available for network creation in specific zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "true if need to list only network offerings which support specifying ip ranges", + "length": 255, + "name": "specifyipranges", + "required": false, "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list network offerings by guest type: shared or isolated", + "length": 255, + "name": "guestiptype", + "required": false, "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" - } - ] - }, - { - "description": "Lists supported Kubernetes version", - "isasync": false, - "name": "listKubernetesSupportedVersions", - "params": [ + }, + { + "description": "list network offerings by ID", + "length": 255, + "name": "id", + "related": "listNetworkOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "length": 255, + "name": "routingmode", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "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": "the minimum semantic version for the Kubernetes supported version to be listed", + "description": "the tags for the network offering.", "length": 255, - "name": "minimumsemanticversion", + "name": "specifyvlan", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "the availability of network offering. Default value is required", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "availability", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "list network offerings by tags", + "length": 4096, + "name": "tags", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the network offering can be used only for network creation inside the VPC", "length": 255, - "name": "keyword", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the Kubernetes supported version", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "id", - "related": "listKubernetesSupportedVersions", + "name": "sourcenatsupported", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the minimum Kubernetes supported version", + "description": "list by traffic type", "length": 255, - "name": "minimumkubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "traffictype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "true if need to list only default network offerings. Default value is false", "length": 255, - "name": "pagesize", + "name": "isdefault", "required": false, - "type": "integer" + "type": "boolean" } ], "related": "", "response": [ { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", - "type": "string" + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", - "type": "string" + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", + "type": "boolean" }, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the id of the network offering", + "name": "id", "type": "string" }, { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", - "type": "string" + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", - "type": "string" + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", + "type": "boolean" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "Name of the Kubernetes supported version", - "name": "name", - "type": "string" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", "type": "boolean" }, { - "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", "type": "boolean" }, - {}, - {}, { - "description": "the id of the Kubernetes supported version", - "name": "id", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", "type": "integer" }, { @@ -112433,146 +126331,195 @@ "type": "integer" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", - "type": "string" + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "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": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, + {}, + {}, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" - } - ] - }, - { - "description": "Adds a Nicira NVP device", - "isasync": true, - "name": "addNiciraNvpDevice", - "params": [ + "description": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "type": "string" + }, { - "description": "Hostname of ip address of the Nicira NVP Controller.", - "length": 255, - "name": "hostname", - "required": true, + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "The Transportzone UUID configured on the Nicira Controller", - "length": 255, - "name": "transportzoneuuid", - "required": true, + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "Credentials to access the Nicira Controller API", - "length": 255, - "name": "username", - "required": true, + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "The L2 Gateway Service UUID configured on the Nicira Controller", - "length": 255, - "name": "l2gatewayserviceuuid", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Credentials to access the Nicira Controller API", - "length": 255, - "name": "password", - "required": true, + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "type": "string" }, { - "description": "The L3 Gateway Service UUID configured on the Nicira Controller", - "length": 255, - "name": "l3gatewayserviceuuid", - "required": false, + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the transport zone Uuid", - "name": "transportzoneuuid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "device name", - "name": "niciradevicename", - "type": "string" + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "type": "string" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "type": "boolean" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" + }, + { + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", + "type": "boolean" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" } ] }, { - "description": "Lists network serviceproviders for a given physical network.", + "description": "Lists dedicated pods.", "isasync": false, - "name": "listNetworkServiceProviders", + "name": "listDedicatedPods", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -112581,11 +126528,12 @@ "type": "string" }, { - "description": "list providers by name", + "description": "list dedicated pods by affinity group", "length": 255, - "name": "name", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -112595,36 +126543,46 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "the name of the account associated with the pod. Must be used with domainId.", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the ID of the pod", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "list providers by state", + "description": "", "length": 255, - "name": "state", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "the ID of the domain associated with the pod", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "uuid of the network provider", - "name": "id", + "description": "the ID of the Pod", + "name": "podid", "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, { @@ -112632,67 +126590,21 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "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": "state of the network provider", - "name": "state", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "delete Tungsten-Fabric tag type", - "isasync": true, - "name": "deleteTungstenFabricTagType", - "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the ID of Tungsten-Fabric tag type", - "length": 255, - "name": "tagtypeuuid", - "required": true, - "type": "string" - } - ], - "response": [ { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", + "type": "string" }, {}, { @@ -112700,200 +126612,141 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", + "type": "string" } ] }, { - "description": "Lists infrastructure", + "description": "Lists VPCs", "isasync": false, - "name": "listInfrastructure", - "params": [], - "related": "", - "response": [ - { - "description": "Number of object stores", - "name": "objectstores", - "type": "integer" - }, - {}, - { - "description": "Number of clusters", - "name": "clusters", - "type": "integer" - }, + "name": "listVPCs", + "params": [ { - "description": "Number of cpu sockets", - "name": "cpusockets", - "type": "integer" + "description": "list VPCs by restartRequired option", + "length": 255, + "name": "restartrequired", + "required": false, + "type": "boolean" }, { - "description": "Number of hypervisor hosts", - "name": "hosts", - "type": "integer" + "description": "list by zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "length": 255, + "name": "cidr", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Number of images stores", - "name": "imagestores", - "type": "integer" - }, - { - "description": "Number of storage pools", - "name": "storagepools", - "type": "integer" - }, - { - "description": "Number of Alerts", - "name": "alerts", - "type": "integer" - }, - {}, - { - "description": "Number of management servers", - "name": "managementservers", - "type": "integer" - }, - { - "description": "Number of internal LBs", - "name": "ilbvms", - "type": "integer" - }, - { - "description": "Number of routers", - "name": "routers", - "type": "integer" - }, - { - "description": "Number of zones", - "name": "zones", - "type": "integer" - }, - { - "description": "Number of systemvms", - "name": "systemvms", - "type": "integer" + "description": "list by ID of the VPC offering", + "length": 255, + "name": "vpcofferingid", + "related": "updateVPCOffering", + "required": false, + "type": "uuid" }, { - "description": "Number of pods", - "name": "pods", - "type": "integer" - } - ], - "since": "4.9.3" - }, - { - "description": "Lists usage records for accounts", - "isasync": false, - "name": "listUsageRecords", - "params": [ - { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "oldformat", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "usageid", + "name": "account", "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).", + "description": "List by keyword", "length": 255, - "name": "startdate", - "required": true, - "type": "date" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "List usage records for specified 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. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "projectid", - "related": "activateProject,suspendProject", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List usage records for the specified user.", + "description": "list VPCs by state", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" }, { - "description": "List usage records for the specified usage type", + "description": "", "length": 255, - "name": "type", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { - "description": "List usage records for the specified domain.", + "description": "flag to display the resource icon for VPCs", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "description": "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.15", "type": "boolean" }, { - "description": "Flag to enable display of Tags for a resource", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "includetags", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "", + "description": "list VPC supporting certain services", "length": 255, - "name": "pagesize", + "name": "supportedservices", "required": false, - "type": "integer" + "type": "list" }, { - "description": "List usage records for the specified account", + "description": "list VPC by id", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts,listAccounts", + "name": "id", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "List by display text of the VPC", "length": 255, - "name": "keyword", + "name": "displaytext", "required": false, "type": "string" }, { - "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).", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "enddate", - "required": true, - "type": "date" + "name": "tags", + "required": false, + "type": "map" }, { "description": "", @@ -112901,119 +126754,267 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "list by name of the VPC", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], - "related": "", + "related": "createVPC,listVPCs,updateVPC", "response": [ { - "description": "memory allocated for the resource", - "name": "memory", - "type": "long" - }, - { - "description": "usage type ID", - "name": "usagetype", - "type": "integer" + "description": "the id of the VPC", + "name": "id", + "type": "string" }, { - "description": "end date of the usage record", - "name": "enddate", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "type": "string" }, - {}, { - "description": "start date of the usage record", - "name": "startdate", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user account name", - "name": "account", - "type": "string" + "description": "the date this VPC was created", + "name": "created", + "type": "date" }, { - "description": "virtual size of resource", - "name": "virtualsize", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the zone ID", - "name": "zoneid", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { - "description": "virtual machine ID", - "name": "virtualmachineid", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "template ID", - "name": "templateid", + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", "type": "string" }, { - "description": "the domain ID", - "name": "domainid", + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "usage in hours", - "name": "usage", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, + {}, { - "description": "the project name of the resource", + "description": "the project name of the VPC", "name": "project", "type": "string" }, { - "description": "resource type", - "name": "type", - "type": "string" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "virtual machine os category name", - "name": "oscategoryname", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "virtual machine os type ID", - "name": "ostypeid", - "type": "string" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", - "name": "issystem", - "type": "boolean" + "description": "the list of resource tags associated with the project", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" }, { - "description": "the project id of the resource", - "name": "projectid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "number of cpu of resource", - "name": "cpunumber", - "type": "long" + "description": "the list of supported services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "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" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "speed of each cpu of resource", - "name": "cpuspeed", + "description": "AS NUMBER", + "name": "asnumber", "type": "long" }, { - "description": "the user account Id", - "name": "accountid", + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" + }, + { + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "virtual machine guest os category ID", - "name": "oscategoryid", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { @@ -113021,189 +127022,115 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "description of the usage record", - "name": "description", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" }, { - "description": "raw usage in hours", - "name": "rawusage", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "True if the resource is default", - "name": "isdefault", + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", "type": "boolean" }, { - "description": "resource size", - "name": "size", - "type": "long" + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" }, { - "description": "id of the resource", - "name": "usageid", - "type": "string" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "id of the network", - "name": "networkid", + "description": "the domain id of the VPC owner", + "name": "domainid", "type": "string" }, { - "description": "id of the vpc", - "name": "vpcid", - "type": "string" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" }, { - "description": "the domain the resource is associated with", - "name": "domain", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "resource or virtual machine name", - "name": "name", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", "type": "boolean" }, { - "description": "offering ID", - "name": "offeringid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "virtual machine os display name", - "name": "osdisplayname", - "type": "string" + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - } - ] - }, - { - "description": "Deletes an Object Storage Pool", - "isasync": false, - "name": "deleteObjectStoragePool", - "params": [ - { - "description": "The Object Storage ID.", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if VPC is region level", + "name": "regionlevelvpc", "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", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, {} - ], - "since": "4.19.0" + ] }, { - "description": "Delete Netscaler Control Center", + "description": "Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer", "isasync": false, - "name": "deleteNetscalerControlCenter", + "name": "addNetworkDevice", "params": [ { - "description": "Netscaler Control Center ID", + "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", "length": 255, - "name": "id", - "related": "", - "required": true, + "name": "networkdevicetype", + "required": false, "type": "string" + }, + { + "description": "parameters for network device", + "length": 255, + "name": "networkdeviceparameterlist", + "required": false, + "type": "map" } ], + "related": "", "response": [ + {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ID of the network device", + "name": "id", "type": "string" }, { @@ -113211,12 +127138,6 @@ "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", @@ -113226,400 +127147,574 @@ ] }, { - "description": "Deletes a detached disk volume.", - "isasync": false, - "name": "deleteVolume", + "description": "Execute network-utility command (ping/arping/tracert) on system VMs remotely", + "isasync": true, + "name": "runDiagnostics", "params": [ { - "description": "The ID of the disk volume", + "description": "Additional command line options that apply for each command", "length": 255, - "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "params", + "required": false, + "type": "string" + }, + { + "description": "The IP/Domain address to test connection to", + "length": 255, + "name": "ipaddress", + "required": true, + "type": "string" + }, + { + "description": "The ID of the system VM instance to diagnose", + "length": 255, + "name": "targetid", + "related": "startSystemVm", "required": true, "type": "uuid" + }, + { + "description": "The system VM diagnostics type valid options are: ping, traceroute, arping", + "length": 255, + "name": "type", + "required": true, + "type": "string" } ], + "related": "", "response": [ - {}, {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the command execution return code", + "name": "exitcode", + "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": "the standard error output from the command execution", + "name": "stderr", + "type": "string" + }, + { + "description": "the standard output from the command execution", + "name": "stdout", + "type": "string" } - ] + ], + "since": "4.12.0.0" }, { - "description": "Recovers a Destroy volume.", - "isasync": false, - "name": "recoverVolume", + "description": "Restarts a VPC", + "isasync": true, + "name": "restartVPC", "params": [ { - "description": "The ID of the volume", + "description": "Turn a single VPC into a redundant one.", + "length": 255, + "name": "makeredundant", + "required": false, + "type": "boolean" + }, + { + "description": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", + "length": 255, + "name": "livepatch", + "required": false, + "since": "4.17.0", + "type": "boolean" + }, + { + "description": "the id of the VPC", "length": 255, "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "createVPC,listVPCs,updateVPC", "required": true, "type": "uuid" + }, + { + "description": "If cleanup old network elements", + "length": 255, + "name": "cleanup", + "required": false, + "type": "boolean" } ], - "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ] + }, + { + "description": "adds a baremetal dhcp server", + "isasync": true, + "name": "addBaremetalDhcp", + "params": [ + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "Credentials to reach external dhcp device", + "length": 255, + "name": "username", + "required": true, + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "Type of dhcp device", + "length": 255, + "name": "dhcpservertype", + "required": true, "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "Credentials to reach external dhcp device", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "URL of the external dhcp appliance.", + "length": 255, + "name": "url", + "required": true, + "type": "string" + } + ], + "related": "listBaremetalDhcp", + "response": [ + { + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "name of the provider", + "name": "dhcpservertype", "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": "url", + "name": "url", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "delete Tungsten-Fabric application policy set", + "isasync": true, + "name": "deleteTungstenFabricApplicationPolicySet", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": true, + "type": "string" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the 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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Copies a snapshot from one zone to another.", + "isasync": true, + "name": "copySnapshot", + "params": [ + { + "description": "The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used.", + "length": 255, + "name": "sourcezoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" + "description": "the ID of the snapshot.", + "length": 255, + "name": "id", + "related": "copySnapshot,listSnapshots", + "required": true, + "type": "uuid" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required.", + "length": 255, + "name": "destzoneids", + "related": "listZones", + "required": false, + "type": "list" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "The ID of the zone the snapshot is being copied to.", + "length": 255, + "name": "destzoneid", + "related": "listZones", + "required": false, + "type": "uuid" + } + ], + "related": "listSnapshots", + "response": [ + { + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the project name of the snapshot", + "name": "project", "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": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "state of the disk volume", + "name": "volumestate", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage", + "name": "state", + "type": "state" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", + "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "the domain associated with the disk volume", + "description": "the domain name of the snapshot's account", "name": "domain", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the current status of the latest async job acting 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 availability zone", - "name": "zoneid", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, + {}, { - "description": "the status of the volume", - "name": "status", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "name of the snapshot", + "name": "name", + "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, + {}, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { "description": "the 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 optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "name of the disk volume", - "name": "name", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, { "description": "name of the availability zone", "name": "zonename", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "ID of the snapshot", + "name": "id", + "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Adds Traffic Monitor Host for Direct Network Usage", + "isasync": false, + "name": "addTrafficMonitor", + "params": [ + { + "description": "Zone in which to add the external firewall appliance.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "Traffic going into the listed zones will be metered", + "length": 255, + "name": "includezones", + "required": false, "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "Traffic going into the listed zones will not be metered", + "length": 255, + "name": "excludezones", + "required": false, + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, + "description": "URL of the traffic monitor Host", + "length": 255, + "name": "url", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { @@ -113628,463 +127723,596 @@ "type": "integer" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, {}, + {}, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, - {}, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the ID of the external firewall", + "name": "id", "type": "string" + } + ] + }, + { + "description": "Lists user accounts", + "isasync": false, + "name": "listUsers", + "params": [ + { + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "length": 255, + "name": "accounttype", + "required": false, + "type": "integer" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "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 user by the username", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - } - ], - "since": "4.14.0" - }, - { - "description": "remove Tungsten-Fabric network gateway from logical router", - "isasync": true, - "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", - "params": [ + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { - "description": "Tungsten-Fabric network uuid", + "description": "List users by state of the user account.", "length": 255, - "name": "networkuuid", - "required": true, + "name": "state", + "required": false, "type": "string" }, { - "description": "the ID of zone", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" }, { - "description": "Tungsten-Fabric logical router uuid", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "logicalrouteruuid", - "required": true, + "name": "account", + "required": false, "type": "string" + }, + { + "description": "List user by ID.", + "length": 255, + "name": "id", + "related": "disableUser,getUser,listUsers", + "required": false, + "type": "uuid" + }, + { + "description": "flag to display the resource icon for users", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" } ], - "related": "", + "related": "disableUser,getUser", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "Tungsten-Fabric logical router name", - "name": "name", + "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 user ID", + "name": "id", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user state", + "name": "state", "type": "string" }, - {} - ] - }, - { - "description": "Updates an existing secondary storage selector.", - "isasync": false, - "name": "updateSecondaryStorageSelector", - "params": [ + {}, { - "description": "The unique identifier of the secondary storage selector.", - "length": 255, - "name": "id", - "related": "updateSecondaryStorageSelector,removeSecondaryStorageSelector", - "required": true, - "type": "uuid" + "description": "the user name", + "name": "username", + "type": "string" }, { - "description": "The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.", - "length": 65535, - "name": "heuristicrule", - "required": true, + "description": "the timezone user was created in", + "name": "timezone", "type": "string" - } - ], - "related": "removeSecondaryStorageSelector", - "response": [ + }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "Description of the heuristic.", - "name": "description", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "Name of the heuristic.", - "name": "name", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" } - ], - "since": "4.19.0" + ] }, { - "description": "Enables a user account", + "description": "Updates a VLAN IP range.", "isasync": false, - "name": "enableUser", + "name": "updateVlanIpRange", "params": [ { - "description": "Enables user by user ID.", + "description": "the beginning IP address in the VLAN IP range", + "length": 255, + "name": "startip", + "required": false, + "type": "string" + }, + { + "description": "the netmask of the VLAN IP range", + "length": 255, + "name": "netmask", + "required": false, + "type": "string" + }, + { + "description": "the UUID of the VLAN IP range", "length": 255, "name": "id", - "related": "createUser,enableUser,getUser", + "related": "updateVlanIpRange", "required": true, "type": "uuid" - } - ], - "related": "createUser,getUser", - "response": [ + }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the gateway of the VLAN IP range", + "length": 255, + "name": "gateway", + "required": false, "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" + "description": "the ending IP address in the VLAN IP range", + "length": 255, + "name": "endip", + "required": false, + "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the ending IPv6 address in the IPv6 network range", + "length": 255, + "name": "endipv6", + "required": false, "type": "string" }, { - "description": "the account name of the user", - "name": "account", - "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 ID of the role", - "name": "roleid", + "description": "the CIDR of IPv6 network, must be at least /64", + "length": 255, + "name": "ip6cidr", + "required": false, "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the gateway of the IPv6 network", + "length": 255, + "name": "ip6gateway", + "required": false, "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "description": "the beginning IPv6 address in the IPv6 network range", + "length": 255, + "name": "startipv6", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the VLAN IP range", + "name": "id", + "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", + "type": "string" }, { - "description": "the domain name of the user", + "description": "the cidr of the VLAN IP range", + "name": "cidr", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the domain name of the VLAN IP range", "name": "domain", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the Pod ID for the VLAN IP range", + "name": "podid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, - {}, { - "description": "the api key of the user", - "name": "apikey", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "the project name of the vlan range", + "name": "project", + "type": "string" + }, + { + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", "type": "boolean" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", + "description": "indicates whether IP range is dedicated to NSX resources or not", + "name": "fornsx", "type": "boolean" }, - {}, { - "description": "the user lastname", - "name": "lastname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", + "type": "string" + }, + { + "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 type of the role", - "name": "roletype", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" } - ] + ], + "since": "4.16.0" }, { - "description": "Lists zone metrics", + "description": "Lists resource limits.", "isasync": false, - "name": "listZonesMetrics", + "name": "listResourceLimits", "params": [ { - "description": "the IDs of the zones, mutually exclusive with id", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "ids", - "related": "createZone,listZones", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.19.0", - "type": "list" + "type": "uuid" }, { - "description": "", + "description": "Lists resource limits by ID.", "length": 255, - "name": "page", + "name": "id", "required": false, - "type": "integer" + "type": "long" }, { - "description": "", + "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": "pagesize", + "name": "resourcetype", "required": false, "type": "integer" }, { - "description": "the ID of the zone", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createZone,listZones", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "flag to display the resource image for the zones", + "description": "List by keyword", "length": 255, - "name": "showicon", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the network type of the zone that the virtual machine belongs to", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "networktype", + "name": "account", "required": false, "type": "string" }, { - "description": "true if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one VM. Default is false.", + "description": "Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "available", + "name": "resourcetypename", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the domain associated with the zone", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "Tag for the resource type", "length": 255, - "name": "tags", + "name": "tag", "required": false, - "since": "4.3", - "type": "map" + "since": "4.20.0", + "type": "string" }, { - "description": "flag to display the capacity of the zones", + "description": "", "length": 255, - "name": "showcapacities", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the name of the zone", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "name", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" } ], "related": "", "response": [ + {}, { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "the account of the resource limit", + "name": "account", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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": "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 UUID of the latest async job acting on this object", @@ -114092,1106 +128320,877 @@ "type": "string" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", - "type": "string" - }, - { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "The tag for the resource limit", + "name": "tag", "type": "string" }, { - "description": "the total cpu used in Ghz", - "name": "cpuused", + "description": "path of the domain to which the resource limit belongs", + "name": "domainpath", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" }, + {}, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the project name of the resource limit", + "name": "project", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", + "description": "the domain name of the resource limit", + "name": "domain", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", + "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 type of the zone - core or edge", - "name": "type", + "description": "the domain ID of the resource limit", + "name": "domainid", "type": "string" - }, + } + ] + }, + { + "description": "Disables a user account", + "isasync": true, + "name": "disableUser", + "params": [ { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "Disables user by user ID.", + "length": 255, + "name": "id", + "related": "disableUser,getUser", + "required": true, + "type": "uuid" + } + ], + "related": "getUser", + "response": [ + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", + "description": "true if user is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "Zone name", - "name": "name", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "Zone id", - "name": "id", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, {}, { - "description": "Zone Token", - "name": "zonetoken", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the total cpu used in GiB", - "name": "memoryused", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, - {}, { - "description": "healthy / total clusters in the zone", - "name": "clusters", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" - }, - { - "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": "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 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": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", - "response": [ - { - "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 Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "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 Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", "type": "boolean" }, + {}, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", - "type": "boolean" - }, - { - "description": "Zone description", - "name": "description", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "state of the cluster", + "description": "the user state", "name": "state", "type": "string" } - ], - "since": "4.9.3" + ] }, { - "description": "Extracts a template", - "isasync": true, - "name": "extractTemplate", + "description": "Lists all available ISO files.", + "isasync": false, + "name": "listIsos", "params": [ { - "description": "the ID of the zone where the ISO is originally located", + "description": "list all ISOs by name", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the template", + "description": "If set to true, list only unique isos across zones", "length": 255, - "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "name": "showunique", + "required": false, + "since": "4.13.2", + "type": "boolean" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "List by keyword", "length": 255, - "name": "mode", - "required": true, - "type": "string" - }, - { - "description": "the url to which the ISO would be extracted", - "length": 2048, - "name": "url", + "name": "keyword", "required": false, "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the name of the extracted object", - "name": "name", - "type": "string" - }, - { - "description": "the account id to which the extracted object belongs", - "name": "accountid", - "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", "type": "string" }, { - "description": "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": "true if the ISO is bootable, false otherwise", + "length": 255, + "name": "bootable", + "required": false, + "type": "boolean" }, { - "description": "zone name the object was extracted from", - "name": "zonename", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, - {}, { - "description": "the id of extracted object", - "name": "id", - "type": "string" + "description": "ID of the image or image cache store", + "length": 255, + "name": "imagestoreid", + "related": "listSwifts", + "required": false, + "since": "4.19", + "type": "uuid" }, { - "description": "", - "name": "resultstring", - "type": "string" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, - {}, { - "description": "the status of the extraction", - "name": "status", - "type": "string" + "description": "ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "since": "4.19", + "type": "uuid" }, { - "description": "type of the storage", - "name": "storagetype", - "type": "string" + "description": "true if this ISO is ready to be deployed", + "length": 255, + "name": "isready", + "required": false, + "type": "boolean" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the hypervisor for which to restrict the search", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", - "type": "string" + "description": "show removed ISOs as well", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" }, { - "description": "the upload id of extracted object", - "name": "extractId", - "type": "string" - } - ] - }, - { - "description": "Expunge a virtual machine. Once expunged, it cannot be recoverd.", - "isasync": true, - "name": "expungeVirtualMachine", - "params": [ + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, { - "description": "The ID of the virtual machine", + "description": "list ISO by ID", "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, + "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } - ] - }, - { - "description": "Suspends a project", - "isasync": true, - "name": "suspendProject", - "params": [ + "description": "flag to display the resource image for the isos", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" + }, { - "description": "id of the project to be suspended", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "id", - "related": "activateProject,suspendProject", - "required": true, + "name": "tags", + "required": false, + "type": "map" + }, + { + "description": "the ID of the zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, "type": "uuid" } ], - "related": "activateProject", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" - }, - { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "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) available to be created for this project", - "name": "memoryavailable", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, + {}, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "the state of the project", - "name": "state", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the name of the project", - "name": "name", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "type": "long" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "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 total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, {}, - {}, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" - }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "the domain id the project belongs to", - "name": "domainid", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "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 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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "3.0.0" - }, - { - "description": "Updates an IP address", - "isasync": true, - "name": "updateIpAddress", - "params": [ - { - "description": "an optional field, whether to the display the IP to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "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", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the public IP address to update", - "length": 255, - "name": "id", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" - } - ], - "related": "associateIpAddress,listPublicIpAddresses", - "response": [ - { - "description": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", - "name": "purpose", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "public IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "the list of resource tags associated with ip address", + "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", - "type": "string" - }, + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + } + ] + }, + { + "description": "Lists autoscale policies.", + "isasync": false, + "name": "listAutoScalePolicies", + "params": [ { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, - {}, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the name of the autoscale policy", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" + "description": "the ID of the condition of the policy", + "length": 255, + "name": "conditionid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "public IP address id", - "name": "id", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "length": 255, + "name": "action", + "required": false, + "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "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": "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 autoscale policy", + "length": 255, + "name": "id", + "related": "listAutoScalePolicies", + "required": false, + "type": "uuid" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" - }, + "description": "the ID of the autoscale vm group", + "length": 255, + "name": "vmgroupid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the account the public IP address is associated with", - "name": "account", - "type": "string" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", "type": "integer" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, + {}, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain ID of the autoscale policy", + "name": "domainid", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the autoscale policy ID", + "name": "id", + "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the project id autoscale policy", + "name": "projectid", "type": "string" }, { - "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": "Get API limit count for the caller", - "isasync": false, - "name": "getApiLimit", - "params": [], - "related": "", - "response": [ + }, { - "description": "the account uuid of the api remaining count", - "name": "accountid", + "description": "the account owning the autoscale policy", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, { @@ -115201,52 +129200,70 @@ }, {}, { - "description": "number of api already issued", - "name": "apiIssued", - "type": "int" - }, - {}, - { - "description": "currently allowed number of apis", - "name": "apiAllowed", - "type": "int" - }, - { - "description": "the account name of the api remaining count", - "name": "account", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "seconds left to reset counters", - "name": "expireAfter", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" } ] }, { - "description": "Deletes a storage network IP Range.", + "description": "Dedicates an existing IPv4 subnet for a zone to an account or a domain.", "isasync": true, - "name": "deleteStorageNetworkIpRange", + "name": "dedicateIpv4SubnetForZone", "params": [ { - "description": "the uuid of the storage network ip range", + "description": "domain ID of the account owning the IPv4 subnet", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "project who will own the IPv4 subnet", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "Id of the guest network IPv4 subnet", "length": 255, "name": "id", - "related": "createStorageNetworkIpRange", + "related": "dedicateIpv4SubnetForZone", "required": true, "type": "uuid" + }, + { + "description": "account who will own the IPv4 subnet", + "length": 255, + "name": "account", + "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 domain name of the IPv4 subnet", + "name": "domain", + "type": "string" + }, + { + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + { + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -115254,851 +129271,1221 @@ "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, {}, + { + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "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 project name of the IPv4 subnet", + "name": "project", + "type": "string" + }, + { + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "type": "string" + }, + { + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", + "type": "string" + }, + { + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" } ], - "since": "3.0.0" + "since": "4.20.0" }, { - "description": "moves a network to another physical network", - "isasync": true, - "name": "migrateNetwork", + "description": "List Shared FileSystems", + "isasync": false, + "name": "listSharedFileSystems", "params": [ { - "description": "the ID of the network", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": true, - "type": "uuid" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "network offering ID", + "description": "", "length": 255, - "name": "networkofferingid", - "related": "", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if previous network migration cmd failed", + "description": "the name of the shared filesystem", "length": 255, - "name": "resume", + "name": "name", "required": false, - "type": "boolean" - } - ], - "related": "createNetwork,updateNetwork,listNetworks", - "response": [ - { - "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 first IPv4 DNS for the network", - "name": "dns1", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", + "required": false, + "type": "uuid" }, { - "description": "The external id of the network", - "name": "externalid", - "type": "string" + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the disk offering of the shared filesystem", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the ID of the network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, { - "description": "the type of the network", - "name": "type", - "type": "string" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", - "name": "networkcidr", - "type": "string" + "description": "the service offering of the shared filesystem", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" }, { - "description": "the name of the Network associated with this network", - "name": "associatednetwork", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" + } + ], + "related": "changeSharedFileSystemDiskOffering", + "response": [ + { + "description": "the bytes allocated", + "name": "virtualsize", + "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": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", - "type": "boolean" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", "type": "boolean" }, - {}, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, + {}, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the list of resource tags associated with network", - "name": "tags", + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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 IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 nic", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "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 cidr of IPv6 network", + "name": "ip6cidr", + "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" } ], "type": "list" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "the filesystem format", + "name": "filesystem", + "type": "string" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "the state of the shared filesystem", + "name": "state", + "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "the ID of the Network associated with this network", - "name": "associatednetworkid", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + { + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "adds baremetal rack configuration text", + "isasync": true, + "name": "addBaremetalRct", + "params": [ + { + "description": "http url to baremetal RCT configuration", + "length": 255, + "name": "baremetalrcturl", + "required": true, + "type": "object" + } + ], + "related": "", + "response": [ + { + "description": "id of rct", + "name": "id", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "url", + "name": "url", "type": "string" }, + {}, + {} + ] + }, + { + "description": "Updates a role", + "isasync": false, + "name": "updateRole", + "params": [ { - "description": "the id of the network", - "name": "id", + "description": "The description of the role", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the name of the network", + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", + "length": 255, + "name": "ispublic", + "required": false, + "type": "boolean" + }, + { + "description": "creates a role with this unique name", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "The description of the role", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "length": 255, + "name": "type", + "required": false, + "type": "string" }, { - "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" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - } - ], - "type": "list" - } - ], - "type": "list" + "description": "ID of the role", + "length": 255, + "name": "id", + "related": "listRoles,updateRole", + "required": true, + "type": "uuid" + } + ], + "related": "listRoles", + "response": [ + { + "description": "the state of the role", + "name": "state", + "type": "string" + }, + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" + }, + { + "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" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the name of the role", + "name": "name", + "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the type of the role", + "name": "type", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the role", + "name": "id", + "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the description of the role", + "name": "description", "type": "string" }, + {}, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Lists remote access vpns", + "isasync": false, + "name": "listRemoteAccessVpns", + "params": [ + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "The routing mode of network offering", - "name": "ip6routing", - "type": "string" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "public ip address id of the vpn server", + "length": 255, + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" }, { - "description": "state of the network", - "name": "state", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "Lists remote access vpn rule with the specified ID", + "length": 255, + "name": "id", + "related": "listRemoteAccessVpns", + "required": false, + "since": "4.3", + "type": "uuid" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "list remote access VPNs for certain network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "since": "4.3", + "type": "uuid" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", + "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "the project name of the address", + "description": "the project name of the vpn", "name": "project", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", + "type": "string" }, + {}, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the ipsec preshared key", + "name": "presharedkey", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "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 second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" } - ], - "since": "4.11.0" + ] }, { - "description": "Adds a VMware datacenter to specified zone", + "description": "Deletes a Webhook", "isasync": false, - "name": "addVmwareDc", + "name": "deleteWebhook", "params": [ { - "description": "The Zone ID.", + "description": "The ID of the Webhook", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "id", + "related": "createWebhook", "required": true, "type": "uuid" - }, + } + ], + "response": [ + {}, { - "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, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The password for specified username.", - "length": 255, - "name": "password", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "Name of VMware datacenter to be added to specified zone.", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.20.0" + }, + { + "description": "Deletes a network ACL", + "isasync": true, + "name": "deleteNetworkACLList", + "params": [ + { + "description": "the ID of the network ACL", "length": 255, - "name": "name", + "name": "id", + "related": "createNetworkACLList", "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The Username required to connect to resource.", - "length": 255, - "name": "username", - "required": false, + "description": "any text associated with the 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": "Removes secondary IP from the NIC.", + "isasync": true, + "name": "removeIpFromNic", + "params": [ + { + "description": "the ID of the secondary ip address to nic", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" } ], - "related": "", "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "The VMware Datacenter name", - "name": "name", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, - { - "description": "The VMware Datacenter ID", - "name": "id", - "type": "string" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" } ] }, { - "description": "Updates Ipv6 firewall rule with specified ID", + "description": "Creates a system virtual-machine that implements network services", "isasync": true, - "name": "updateIpv6FirewallRule", + "name": "createServiceInstance", "params": [ { - "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "the starting port of Ipv6 firewall rule", + "description": "An optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "startport", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", + "description": "The template ID that specifies the image for the service appliance", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "Availability zone for the service instance", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the ID of the ipv6 firewall rule", + "description": "The right (outside) network ID for the service instance", "length": 255, - "name": "id", - "related": "updateIpv6FirewallRule", + "name": "rightnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": true, "type": "uuid" }, { - "description": "the ending port of Ipv6 firewall rule", + "description": "Project ID for the service instance", "length": 255, - "name": "endport", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "The name of the service instance", "length": 255, - "name": "protocol", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "error code for this ICMP message", + "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "icmpcode", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "The left (inside) network for service instance", "length": 255, - "name": "traffictype", - "required": false, - "type": "string" + "name": "leftnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, + "type": "uuid" }, { - "description": "type of the ICMP message being sent", + "description": "The service offering ID that defines the resources consumed by the service appliance", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" } ], "related": "", "response": [ - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "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 port forwarding rule", - "name": "id", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "path of the Domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, + {} + ] + }, + { + "description": "Starts a system virtual machine.", + "isasync": true, + "name": "startSystemVm", + "params": [ { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", - "type": "string" - }, + "description": "The ID of the system virtual machine", + "length": 255, + "name": "id", + "related": "startSystemVm", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "description": "the name of the system VM", + "name": "name", "type": "string" }, - {}, - {}, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "type": "string" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -116106,485 +130493,268 @@ "type": "integer" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" - } - ] - }, - { - "description": "Lists unmanaged virtual machines for a given cluster.", - "isasync": false, - "name": "listUnmanagedInstances", - "params": [ + }, { - "description": "the hypervisor name of the instance", - "length": 255, - "name": "name", - "required": false, + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the private netmask for the system VM", + "name": "privatenetmask", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", + "type": "string" + }, { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", - "type": "integer" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", - "response": [ - { - "description": "the file path of the disk image", - "name": "imagepath", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorepath", - "type": "string" - }, - { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" - }, - { - "description": "the controller of the disk", - "name": "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 controller of the disk", - "name": "datastorehost", - "type": "string" - }, - { - "description": "the ID of the disk", - "name": "id", - "type": "string" - }, - { - "description": "the controller of the disk", - "name": "datastorename", - "type": "string" - }, - { - "description": "the position of the disk", - "name": "position", - "type": "integer" - } - ], - "type": "set" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "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 corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "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 cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the 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" - } - ], - "type": "set" + "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 state of the system VM", + "name": "state", + "type": "string" }, { - "description": "the memory of the virtual machine in MB", - "name": "memory", - "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 CPU speed of the virtual machine", - "name": "cpuspeed", - "type": "integer" + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, - {}, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", - "type": "integer" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "the operating system of the virtual machine", - "name": "osdisplayname", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" + }, + { + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the name of the host to which virtual machine belongs", + "description": "the hostname for the system VM", "name": "hostname", "type": "string" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, - {} - ], - "since": "4.14.0" - }, - { - "description": "Updates ISO permissions", - "isasync": false, - "name": "updateIsoPermissions", - "params": [ { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "projectids", - "related": "activateProject", - "required": false, - "type": "list" + "description": "the gateway for the system VM", + "name": "gateway", + "type": "string" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the template ID", - "length": 255, - "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "true for featured template/iso, false otherwise", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "permission operator (add, remove, reset)", - "length": 255, - "name": "op", - "required": false, + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "true for public template/iso, false for private templates/isos", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - } - ], - "response": [ + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + { + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" + }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", + "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the template ID for the system VM", + "name": "templateid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the systemvm agent version", + "name": "version", + "type": "string" + }, + { + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, { - "description": "Registers an existing template into the CloudStack cloud.", + "description": "Registers an existing VNF template into the CloudStack cloud. ", "isasync": false, - "name": "registerTemplate", + "name": "registerVnfTemplate", "params": [ { - "description": "A list of zone ids where the template will be hosted. Use this parameter if the template needs to be registered to multiple zones in one go. Use zoneid if the template needs to be registered to only one zone.Passing only -1 to this will cause the template to be registered as a cross zone template and will be copied to all zones. ", + "description": "Register template for the project", "length": 255, - "name": "zoneids", - "related": "createZone,listZones", + "name": "projectid", + "related": "", "required": false, - "type": "list" + "type": "uuid" + }, + { + "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", + "length": 255, + "name": "vnfdetails", + "required": false, + "type": "map" + }, + { + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", "length": 255, - "name": "details", + "name": "vnfnics", "required": false, "type": "map" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "bits", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "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 the template supports the sshkey upload feature; default is false", "length": 255, - "name": "templatetype", + "name": "sshkeyenabled", "required": false, - "since": "4.19.0", - "type": "string" + "type": "boolean" }, { - "description": "the name of the template", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "name", + "name": "format", "required": true, "type": "string" }, { - "description": "true if this template requires HVM", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "requireshvm", + "name": "templatetype", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "string" }, { "description": "an optional accountName. Must be used with domainId.", @@ -116594,26 +130764,33 @@ "type": "string" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", - "required": true, - "type": "string" + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "description": "the target hypervisor for the template", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "hypervisor", - "required": true, + "name": "arch", + "required": false, + "since": "4.20", "type": "string" }, { - "description": "Register template for the project", + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, + { + "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { "description": "true if this template is a featured template, false otherwise", @@ -116623,71 +130800,61 @@ "type": "boolean" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "true if this template requires HVM", "length": 255, - "name": "sshkeyenabled", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "listDomainChildren,listDomains", + "name": "zoneids", + "related": "listZones", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "zoneid", - "related": "createZone,listZones", + "name": "bits", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "checksum", + "name": "passwordenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "isextractable", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "deployasis", + "name": "ispublic", "required": false, - "since": "4.15.1", "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "isdynamicallyscalable", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "The display text of the template, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "name": "directdownload", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the tag for this template.", @@ -116697,106 +130864,225 @@ "type": "string" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "directdownload", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template", "length": 255, - "name": "isrouting", + "name": "ostypeid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "the name of the template", "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "format", - "required": true, - "type": "string" + "name": "deployasis", + "required": false, + "since": "4.15.1", + "type": "boolean" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "ispublic", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" } ], - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", "response": [ + {}, { - "description": "the template ID", - "name": "id", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" + }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, + { + "description": "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 zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, { "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", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, - {}, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { "description": "the URL which the template/iso is registered from", "name": "url", "type": "string" }, + {}, + { + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" + }, + { + "description": "the project id of the template", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, { "description": "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", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -116810,8 +131096,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -116825,22 +131111,36 @@ "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "set" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { @@ -116848,19 +131148,24 @@ "name": "isfeatured", "type": "boolean" }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, { "description": "the userdata override policy with the userdata provided while deploying VM", "name": "userdatapolicy", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { @@ -116869,84 +131174,44 @@ "type": "long" }, { - "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", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "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": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the template name", + "name": "name", + "type": "string" }, { "description": "the date this template was created", @@ -116954,14 +131219,9 @@ "type": "date" }, { - "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", - "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", @@ -116969,1958 +131229,2283 @@ "type": "resourceiconresponse" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Lists VM stats", + "isasync": false, + "name": "listVirtualMachinesUsageHistory", + "params": [ { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "the IDs of the virtual machines, mutually exclusive with id.", + "length": 255, + "name": "ids", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "list" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "startdate", + "required": false, + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the ID of the virtual machine.", + "length": 255, + "name": "id", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" + } + ], + "related": "listSystemVmsUsageHistory", + "response": [ { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, + {}, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" } - ] + ], + "since": "4.17" }, { - "description": "Deletes VPC offering", + "description": "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host.", "isasync": true, - "name": "deleteVPCOffering", + "name": "declareHostAsDegraded", "params": [ { - "description": "the ID of the VPC offering", + "description": "host ID", "length": 255, "name": "id", - "related": "updateVPCOffering", + "related": "declareHostAsDegraded,reconnectHost", "required": true, "type": "uuid" } ], + "related": "reconnectHost", "response": [ - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, - {} - ] - }, - { - "description": "Adds stratosphere ssp server", - "isasync": false, - "name": "addStratosphereSsp", - "params": [ { - "description": "stratosphere ssp api username", - "length": 255, - "name": "username", - "required": false, + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "stratosphere ssp tenant uuid", - "length": 255, - "name": "tenantuuid", - "required": false, + "description": "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise", + "name": "hasenoughcapacity", + "type": "boolean" + }, + { + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "stratosphere ssp api password", - "length": 255, - "name": "password", - "required": false, + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "stratosphere ssp server url", - "length": 255, - "name": "url", - "required": true, - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "stratosphere ssp api name", - "length": 255, - "name": "name", - "required": true, + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "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": "url of ssp endpoint", - "name": "url", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "zone which this ssp controls", - "name": "zoneid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "server id of the stratosphere ssp server", - "name": "hostid", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "name", - "name": "name", + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, - {}, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Deletes a network ACL", - "isasync": true, - "name": "deleteNetworkACL", - "params": [ + }, { - "description": "the ID of the network ACL", - "length": 255, - "name": "id", - "related": "moveNetworkAclItem", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the host", + "name": "id", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" - } - ] - }, - { - "description": "Creates a storage pool.", - "isasync": false, - "name": "createStoragePool", - "params": [ + }, { - "description": "the tags for the storage pool", - "length": 255, - "name": "tags", - "required": false, + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the name for the storage pool", - "length": 255, - "name": "name", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the details for the storage pool", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the cluster ID for the storage pool", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": false, - "type": "uuid" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "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", - "required": false, + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "length": 255, - "name": "capacityiops", - "required": false, - "type": "long" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "length": 255, - "name": "istagarule", - "required": false, + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "bytes CloudStack can provision from this storage pool", - "length": 255, - "name": "capacitybytes", - "required": false, - "type": "long" - }, - { - "description": "the Pod ID for the storage pool", - "length": 255, - "name": "podid", - "related": "updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the scope of the storage: cluster or zone", - "length": 255, - "name": "scope", - "required": false, + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the Zone ID for the storage pool", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the URL of the storage pool", - "length": 255, - "name": "url", - "required": true, + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "whether the storage should be managed by CloudStack", - "length": 255, - "name": "managed", - "required": false, - "type": "boolean" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the storage provider name", - "length": 255, - "name": "provider", - "required": false, + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" - } - ], - "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", - "response": [ + }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "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 storage pool type", - "name": "type", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, + {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, {}, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "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", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the name of the storage pool", - "name": "name", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Maximum 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": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + { + "description": "the cluster name of the host", + "name": "clustername", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", + "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 overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" } - ] + ], + "since": "4.16.0.0" }, { - "description": "Lists storage pools available for migration of a volume.", - "isasync": false, - "name": "findStoragePoolsForMigration", + "description": "Creates a Kubernetes cluster", + "isasync": true, + "name": "createKubernetesCluster", "params": [ { - "description": "the ID of the volume", + "description": "name for the Kubernetes cluster", "length": 255, - "name": "id", - "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "description for the Kubernetes cluster", "length": 255, - "name": "page", + "name": "description", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "root disk size in GB for each node", "length": 255, - "name": "pagesize", + "name": "noderootdisksize", "required": false, - "type": "integer" + "type": "long" }, { - "description": "List by keyword", + "description": "Deploy cluster for the project", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "", "required": false, - "type": "string" - } - ], - "related": "cancelStorageMaintenance,enableStorageMaintenance", - "response": [ - { - "description": "the storage pool path", - "name": "path", - "type": "string" + "type": "uuid" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "user name for the docker image private registry", + "length": 255, + "name": "dockerregistryusername", + "required": false, "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "availability zone in which Kubernetes cluster to be launched", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "name of the ssh key pair used to login to the virtual machines", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", - "type": "string" + "description": "number of Kubernetes cluster control nodes, default is 1", + "length": 255, + "name": "controlnodes", + "required": false, + "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", + "length": 255, + "name": "externalloadbalanceripaddress", + "required": false, "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.", + "length": 255, + "name": "clustertype", + "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "Network in which Kubernetes cluster is to be launched", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" }, - {}, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "the ID of the service offering for the virtual machines in the cluster.", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "number of Kubernetes cluster worker nodes", + "length": 255, + "name": "size", + "required": false, + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "Kubernetes version with which cluster to be launched", + "length": 255, + "name": "kubernetesversionid", + "related": "listKubernetesSupportedVersions", + "required": false, + "type": "uuid" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "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": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "URL for the docker image private registry", + "length": 255, + "name": "dockerregistryurl", + "required": false, + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "password for the docker image private registry", + "length": 255, + "name": "dockerregistrypassword", + "required": false, + "type": "string" }, + { + "description": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + } + ], + "related": "startKubernetesCluster", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, + { + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" - } - ] - }, - { - "description": "create Tungsten-Fabric tag", - "isasync": true, - "name": "createTungstenFabricTag", - "params": [ + }, { - "description": "Tungsten-Fabric tag type", - "length": 255, - "name": "tagtype", - "required": true, + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "Tungsten-Fabric tag value", - "length": 255, - "name": "tagvalue", - "required": true, - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" + }, { - "description": "list Tungsten-Fabric network", - "name": "network", - "type": "list" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "type": "list" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric tag name", + "description": "the name of the Kubernetes cluster", "name": "name", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", "type": "list" }, - {}, - { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" - } - ] - }, - { - "description": "Adds an OpenDaylight controller", - "isasync": true, - "name": "addOpenDaylightController", - "params": [ { - "description": "Username to access the OpenDaylight API", - "length": 255, - "name": "username", - "required": true, + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "Credential to access the OpenDaylight API", - "length": 255, - "name": "password", - "required": true, - "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 Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork", - "required": true, - "type": "uuid" + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" }, { - "description": "Api URL of the OpenDaylight Controller.", - "length": 255, - "name": "url", - "required": true, + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the name assigned to the controller", - "name": "name", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, + {}, { - "description": "device id of the controller", + "description": "the id of the Kubernetes cluster", "name": "id", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" }, { - "description": "the url of the controller api", - "name": "url", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" } ] }, { - "description": "delete Tungsten-Fabric firewall rule", - "isasync": true, - "name": "deleteTungstenFabricFirewallRule", + "description": "List a storage network IP range.", + "isasync": false, + "name": "listStorageNetworkIpRange", "params": [ { - "description": "the uuid of Tungsten-Fabric firewall rule", + "description": "", "length": 255, - "name": "firewallruleuuid", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the ID of zone", + "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": true, + "related": "listZones", + "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" + "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Creates a Zone.", - "isasync": false, - "name": "createZone", - "params": [ - { - "description": "true if the zone is an edge zone, false otherwise", + "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", "length": 255, - "name": "isedge", + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "required": false, - "since": "4.18.0", - "type": "boolean" + "type": "uuid" }, { - "description": "the first DNS for the Zone", + "description": "List by keyword", "length": 255, - "name": "dns1", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "Allocation state of this Zone for allocation of new resources", + "description": "", "length": 255, - "name": "allocationstate", + "name": "page", "required": false, + "type": "integer" + } + ], + "related": "createStorageNetworkIpRange", + "response": [ + { + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { - "description": "network type of the zone, can be Basic or Advanced", - "length": 255, - "name": "networktype", - "required": true, + "description": "the network uuid of storage network IP range", + "name": "networkid", "type": "string" }, + {}, { - "description": "the name of the Zone", - "length": 255, - "name": "name", - "required": true, + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "length": 255, - "name": "domain", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second DNS for the Zone", - "length": 255, - "name": "dns2", - "required": false, + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, { - "description": "the ID of the containing domain, null for public zones", - "length": 255, - "name": "domainid", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", + "type": "string" }, { - "description": "true if network is security group enabled, false otherwise", - "length": 255, - "name": "securitygroupenabled", - "required": false, - "type": "boolean" + "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", - "length": 255, - "name": "internaldns1", - "required": true, + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "length": 255, - "name": "localstorageenabled", - "required": false, - "type": "boolean" + "description": "the netmask of the storage network IP range", + "name": "netmask", + "type": "string" }, { - "description": "the guest CIDR address for the Zone", - "length": 255, - "name": "guestcidraddress", - "required": false, - "type": "string" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, { - "description": "the first DNS for IPv6 network in the Zone", - "length": 255, - "name": "ip6dns1", - "required": false, + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, + {} + ], + "since": "3.0.0" + }, + { + "description": "Configures a virtual router element.", + "isasync": true, + "name": "configureVirtualRouterElement", + "params": [ { - "description": "the second internal DNS for the Zone", + "description": "Enabled/Disabled the service provider", "length": 255, - "name": "internaldns2", - "required": false, - "type": "string" + "name": "enabled", + "required": true, + "type": "boolean" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "the ID of the virtual router provider", "length": 255, - "name": "ip6dns2", - "required": false, - "type": "string" + "name": "id", + "related": "configureVirtualRouterElement", + "required": true, + "type": "uuid" } ], - "related": "listZones", + "related": "", "response": [ { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the id of the router", + "name": "id", "type": "string" }, + {}, { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", - "type": "integer" + "description": "the account associated with the provider", + "name": "account", + "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + } + ] + }, + { + "description": "Enables HA for a host", + "isasync": true, + "name": "enableHAForHost", + "params": [ + { + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "disableHAForHost", + "response": [ + {}, + { + "description": "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": "Zone Token", - "name": "zonetoken", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "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 HA state of the host", + "name": "hastate", + "type": "hastate" }, + {} + ], + "since": "4.11" + }, + { + "description": "Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect.", + "isasync": true, + "name": "updateVMAffinityGroup", + "params": [ { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", - "type": "string" + "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter", + "length": 255, + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" + "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter", + "length": 255, + "name": "affinitygroupids", + "related": "", + "required": false, + "type": "list" }, - {}, { - "description": "Zone id", + "description": "The ID of the virtual machine", + "length": 255, "name": "id", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + } + ], + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "response": [ + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", - "response": [ - { - "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 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 total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - } - ], - "type": "list" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, - {}, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "Zone name", - "name": "name", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" - } - ], - "type": "set" - }, - { - "description": "Zone description", - "name": "description", - "type": "string" - }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - } - ] - }, - { - "description": "disable a Cisco Nexus VSM device", - "isasync": true, - "name": "disableCiscoNexusVSM", - "params": [ - { - "description": "Id of the Cisco Nexus 1000v VSM device to be deleted", - "length": 255, - "name": "id", - "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", - "required": true, - "type": "uuid" - } - ], - "related": "listCiscoNexusVSMs", - "response": [ - { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" - }, - { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", - "type": "string" - }, - { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", - "type": "string" - }, - { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", - "type": "string" - }, - {}, - { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", - "type": "string" - }, - { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", - "type": "string" - }, - { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" - }, - { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "device state", - "name": "vsmdevicestate", - "type": "string" - }, - {}, - { - "description": "device name", - "name": "vsmdevicename", - "type": "string" - }, - { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" - } - ] - }, - { - "description": "Creates a Storage network IP range.", - "isasync": true, - "name": "createStorageNetworkIpRange", - "params": [ - { - "description": "the gateway for storage network", - "length": 255, - "name": "gateway", - "required": true, - "type": "string" - }, - { - "description": "the ending IP address", - "length": 255, - "name": "endip", - "required": false, - "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the beginning IP address", - "length": 255, - "name": "startip", - "required": true, + "description": "the ID of the virtual machine", + "name": "id", "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 date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "the netmask for storage network", - "length": 255, - "name": "netmask", - "required": true, + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", - "length": 255, - "name": "vlan", - "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - {}, + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, { - "description": "the gateway of the storage network IP range", - "name": "gateway", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the netmask of the storage network IP range", - "name": "netmask", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the end ip of the storage network IP range", - "name": "endip", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" }, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "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 uuid of storage network IP range.", - "name": "id", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the Pod uuid for the storage network IP range", - "name": "podid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the start ip of the storage network IP range", - "name": "startip", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, - {} - ], - "since": "3.0.0" - }, - { - "description": "Lists all children domains belonging to a specified domain", - "isasync": false, - "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, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "flag to display the resource icon for domains", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list children domains by name", - "length": 255, - "name": "name", - "required": false, + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list children domain by parent domain ID.", - "length": 255, - "name": "id", - "related": "listDomainChildren,listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "listDomains", - "response": [ - { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, {}, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" - }, - { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "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 network domain", - "name": "networkdomain", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the state of the domain", - "name": "state", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", + "description": "VNF details", + "name": "vnfdetails", "type": "map" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, + {}, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the state of the virtual machine", + "name": "state", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the name of the domain", - "name": "name", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the ID of the domain", - "name": "id", - "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 ingress rules associated with the security group", + "name": "ingressrule", + "response": [ + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "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 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": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "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 egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the 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 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 domain ID of the security group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "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 cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, + {}, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", - "type": "long" - } - ] - }, - { - "description": "Returns an encrypted password for the VM", - "isasync": false, - "name": "getVMPassword", - "params": [ + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, { - "description": "The ID of the virtual machine", - "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,deployVnfAppliance,importUnmanagedInstance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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 netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the 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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "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 type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + } + ], + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - {}, - {}, { - "description": "The base64 encoded encrypted password of the VM", - "name": "encryptedpassword", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" - } - ] - }, - { - "description": "Assign load balancer rule or list of load balancer rules to a global load balancer rules.", - "isasync": true, - "name": "assignToGlobalLoadBalancerRule", - "params": [ - { - "description": "the list load balancer rules that will be assigned to global load balancer rule", - "length": 255, - "name": "loadbalancerrulelist", - "related": "", - "required": true, - "type": "list" }, { - "description": "Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'", - "length": 255, - "name": "gslblbruleweightsmap", - "required": false, - "type": "map" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the ID of the global load balancer rule", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "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 userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" } ] }, { - "description": "Configures an ovs element.", - "isasync": true, - "name": "configureOvsElement", + "description": "Registers NCC Service Package", + "isasync": false, + "name": "registerNetscalerServicePackage", "params": [ { - "description": "Enabled/Disabled the service provider", + "description": "Description of Service Package", "length": 255, - "name": "enabled", + "name": "description", "required": true, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the ovs provider", + "description": "Name of the service Package.", "length": 255, - "name": "id", - "related": "configureOvsElement", + "name": "name", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "", + "related": "listRegisteredServicePackages", "response": [ + {}, { - "description": "the id of the ovs", - "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" - }, - { - "description": "the account associated with the provider", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "Description of Service Package", + "name": "description", "type": "string" }, {}, @@ -118930,1489 +133515,1479 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, - { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "Service Package UUID", + "name": "id", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "Service Package Name", + "name": "name", "type": "string" - }, - {} + } ] }, { - "description": "Adds S3 Image Store", + "description": "Updates a Webhook", "isasync": false, - "name": "addImageStoreS3", + "name": "updateWebhook", "params": [ { - "description": "S3 secret key", + "description": "The ID of the Webhook", "length": 255, - "name": "secretkey", + "name": "id", + "related": "createWebhook", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Connection TTL (milliseconds)", + "description": "Description for the Webhook", "length": 255, - "name": "connectionttl", + "name": "description", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Connection timeout (milliseconds)", + "description": "Name for the Webhook", "length": 255, - "name": "connectiontimeout", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Whether TCP keep-alive is used", + "description": "Scope of the Webhook", "length": 255, - "name": "usetcpkeepalive", + "name": "scope", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "S3 endpoint", + "description": "Payload URL of the Webhook", "length": 255, - "name": "endpoint", - "required": true, + "name": "payloadurl", + "required": false, "type": "string" }, { - "description": "Use HTTPS instead of HTTP", + "description": "If set to true then SSL verification will be done for the Webhook otherwise not", "length": 255, - "name": "usehttps", + "name": "sslverification", "required": false, "type": "boolean" }, { - "description": "Maximum number of times to retry on error", + "description": "State of the Webhook", "length": 255, - "name": "maxerrorretry", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "S3 access key", + "description": "Secret key of the Webhook", "length": 255, - "name": "accesskey", - "required": true, + "name": "secretkey", + "required": false, "type": "string" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "Name of the storage bucket", - "length": 255, - "name": "bucket", - "required": true, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", - "length": 255, - "name": "s3signer", - "required": false, + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {} + ], + "since": "4.20.0" + }, + { + "description": "Lists the CA public certificate(s) as support by the configured/provided CA plugin", + "isasync": false, + "name": "listCaCertificate", + "params": [ { - "description": "Socket timeout (milliseconds)", + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", "length": 255, - "name": "sockettimeout", + "name": "provider", "required": false, - "type": "integer" + "type": "string" } ], - "related": "listImageStores", + "related": "", "response": [ - {}, { - "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "The CA certificate(s)", + "name": "cacertificates", "type": "string" }, - {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "The client certificate", + "name": "certificate", + "type": "string" }, + {}, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "Private key for the certificate", + "name": "privatekey", "type": "string" - }, + } + ], + "since": "4.11.0" + }, + { + "description": "Provisions a host with a direct download certificate", + "isasync": false, + "name": "provisionTemplateDirectDownloadCertificate", + "params": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the host to provision the certificate", + "length": 255, + "name": "hostid", + "related": "reconnectHost", + "required": true, + "type": "uuid" }, { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" - }, + "description": "the id of the direct download certificate to provision", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "indicates the details in case of failure or host skipped", + "name": "details", "type": "string" }, + {}, + {}, { - "description": "the ID of the image store", - "name": "id", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], - "since": "4.7.0" + "since": "4.17.0" }, { - "description": "Upload a certificate for HTTPS direct template download on KVM hosts", + "description": "Creates a Project role", "isasync": false, - "name": "uploadTemplateDirectDownloadCertificate", + "name": "updateProjectRole", "params": [ { - "description": "Hypervisor type", + "description": "ID of the Project role", "length": 255, - "name": "hypervisor", + "name": "id", + "related": "updateProjectRole", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "(optional) the host ID to upload certificate", + "description": "The description of the Project role", "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", + "name": "description", "required": false, - "type": "uuid" - }, - { - "description": "SSL certificate", - "length": 65535, - "name": "certificate", - "required": true, "type": "string" }, { - "description": "Zone to upload certificate", + "description": "creates a project role with this unique name", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { - "description": "Name for the uploaded certificate", + "description": "ID of project where role is being created", "length": 255, - "name": "name", + "name": "projectid", + "related": "", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the direct download certificate issuer", - "name": "issuer", - "type": "string" - }, - { - "description": "the direct download certificate id", + "description": "the ID of the role", "name": "id", "type": "string" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the id of the project", + "name": "projectid", "type": "string" }, + {}, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", - "type": "string" + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" }, { - "description": "the direct download certificate issuer", - "name": "validity", + "description": "the description of the role", + "name": "description", "type": "string" }, - {}, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the direct download certificate version", - "name": "version", + "description": "the name of the role", + "name": "name", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {} + ], + "since": "4.15.0" + }, + { + "description": "Add a new Ldap Configuration", + "isasync": false, + "name": "addLdapConfiguration", + "params": [ { - "description": "the direct download certificate subject", - "name": "subject", + "description": "linked domain", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "the direct download certificate alias", - "name": "alias", + "description": "Port", + "length": 255, + "name": "port", + "required": true, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "name of the host running the ldap server", + "name": "hostname", "type": "string" }, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "port the 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": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], - "since": "4.11.0" + "since": "4.2.0" }, { - "description": "Import unmanaged virtual machine from a given cluster.", + "description": "create Tungsten-Fabric address group", "isasync": true, - "name": "importUnmanagedInstance", + "name": "createTungstenFabricAddressGroup", "params": [ { - "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": "the cluster ID", + "description": "Tungsten-Fabric ip prefix length", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "ipprefixlen", "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the template for the virtual machine", + "description": "the ID of zone", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "the host name of the instance", + "description": "Tungsten-Fabric ip prefix", "length": 255, - "name": "hostname", - "required": false, + "name": "ipprefix", + "required": true, "type": "string" }, { - "description": "the name of the instance as it is known to the hypervisor", + "description": "Tungsten-Fabric address group name", "length": 255, "name": "name", "required": true, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the display name of the instance", - "length": 255, - "name": "displayname", - "required": false, + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric address group name", + "name": "name", "type": "string" }, + {}, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", - "length": 255, - "name": "nicipaddresslist", - "required": false, - "type": "map" + "description": "Tungsten-Fabric address group ip prefix", + "name": "ipprefix", + "type": "string" }, + {}, { - "description": "VM nic to network id mapping using keys nic and network", - "length": 255, - "name": "nicnetworklist", - "required": false, - "type": "map" + "description": "Tungsten-Fabric address group uuid", + "name": "uuid", + "type": "string" }, { - "description": "import instance for the project", + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" + } + ] + }, + { + "description": "Lists BigSwitch BCF Controller devices", + "isasync": false, + "name": "listBigSwitchBcfDevices", + "params": [ + { + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "used to specify the custom parameters.", + "description": "", "length": 255, - "name": "details", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "description": "the service offering for the virtual machine", + "description": "bigswitch BCF controller device ID", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, + "name": "bcfdeviceid", + "related": "listBigSwitchBcfDevices", + "required": false, "type": "uuid" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "", "length": 255, - "name": "datadiskofferinglist", + "name": "pagesize", "required": false, - "type": "map" + "type": "integer" }, { - "description": "import instance to the domain specified", + "description": "the Physical Network ID", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "physicalnetworkid", + "related": "", "required": false, "type": "uuid" } ], - "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,deployVnfAppliance,importVm", + "related": "", "response": [ { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the controller Ip address", + "name": "hostname", "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 speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the controller username", + "name": "username", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the controller password", + "name": "password", "type": "string" }, + {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "name of the provider", + "name": "provider", "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 physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "NAT support", + "name": "nat", "type": "boolean" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, + } + ], + "since": "4.6.0" + }, + { + "description": "lists registered service packages", + "isasync": false, + "name": "listRegisteredServicePackages", + "params": [ { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "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 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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - } - ], - "type": "set" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the virtual machine", + "description": "Service Package UUID", "name": "id", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "Description of Service Package", + "name": "description", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Service Package Name", + "name": "name", "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": "Change Disk offering of a Shared FileSystem", + "isasync": true, + "name": "changeSharedFileSystemDiskOffering", + "params": [ { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "max iops", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", - "response": [ - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "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 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 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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "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" - } - ], - "type": "set" - }, + { + "description": "the disk offering to use for the underlying storage", + "length": 255, + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the size of the shared filesystem in GiB", + "length": 255, + "name": "size", + "required": false, + "type": "long" + }, + { + "description": "min iops", + "length": 255, + "name": "miniops", + "required": false, + "type": "long" + }, + { + "description": "the ID of the shared filesystem", + "length": 255, + "name": "id", + "related": "changeSharedFileSystemDiskOffering", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name of the group", + "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the list of 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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "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 domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - } - ], - "type": "set" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "the project id of the vm", + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "the project ID of the shared filesystem", "name": "projectid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of nics associated with the shared filesystem", + "name": "nic", "response": [ { - "description": "the ID of the affinity group", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "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 account owning the affinity group", - "name": "account", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, + {}, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the project name of the shared filesystem", + "name": "project", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "the account associated with the virtual machine", + "description": "the account associated with the shared filesystem", "name": "account", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "the read (IO) of disk on the VM", + "description": "the read (IO) of disk on the shared filesystem", "name": "diskioread", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "size of the shared filesystem", + "name": "size", + "type": "long" }, + {}, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "Enables static NAT for given IP address", + "isasync": false, + "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", + "required": false, + "type": "uuid" }, - {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "VM guest NIC secondary IP address for the port forwarding rule", + "length": 255, + "name": "vmguestip", + "required": false, "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the ID of the virtual machine for enabling static NAT feature", + "length": 255, + "name": "virtualmachineid", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "the public IP address ID for which static NAT feature is being enabled", + "length": 255, + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "true if operation 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": "Deletes a Zone.", + "isasync": false, + "name": "deleteZone", + "params": [ + { + "description": "the ID of the Zone", + "length": 255, + "name": "id", + "related": "listZones", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ] + }, + { + "description": "Expunge a Shared FileSystem by id", + "isasync": true, + "name": "expungeSharedFileSystem", + "params": [ { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the ID of the shared filesystem to expunge", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if 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": "OS type id of the vm", - "name": "ostypeid", + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ], + "since": "4.20.0" + }, + { + "description": "upload an existing template into the CloudStack cloud. ", + "isasync": false, + "name": "getUploadParamsForTemplate", + "params": [ + { + "description": "the name of the volume/template/iso", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", + "description": "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.", + "length": 255, + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "true if the template supports the password reset feature; default is false", + "length": 255, "name": "passwordenabled", + "required": false, "type": "boolean" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "true if the template or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "true if this template requires HVM", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "length": 255, + "name": "deployasis", + "required": false, + "since": "4.15.1", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "true if the template supports the sshkey upload feature; default is false", + "length": 255, + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": "Template details in key/value pairs.", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "32 or 64 bits support. 64 by default", + "length": 255, + "name": "bits", + "required": false, "type": "integer" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the template is available to all accounts; default is true", + "length": 255, + "name": "ispublic", + "required": false, "type": "boolean" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", + "required": true, + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the ID of the zone the volume/template/iso is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, - {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "length": 255, + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "description": "Upload volume/template/iso for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "getUploadParamsForIso", + "response": [ + { + "description": "the timestamp after which the signature expires", + "name": "expires", + "type": "string" + }, + { + "description": "signature to be sent in the POST request.", + "name": "signature", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the template/volume ID", + "name": "id", + "type": "uuid" + }, + {}, + { + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", + "type": "string" }, + {}, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + }, + { + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" } ], - "since": "4.14.0" + "since": "4.6.0" }, { - "description": "Lists System VM stats", + "description": "Deletes snapshot policies for the account.", "isasync": false, - "name": "listSystemVmsUsageHistory", + "name": "deleteSnapshotPolicies", "params": [ { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" - }, - { - "description": "the IDs of the system VMs, mutually exclusive with id.", + "description": "list of snapshots policy IDs separated by comma", "length": 255, "name": "ids", - "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,deployVnfAppliance,importVm", + "related": "updateSnapshotPolicy", "required": false, "type": "list" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "the Id of the snapshot policy", "length": 255, - "name": "enddate", + "name": "id", + "related": "updateSnapshotPolicy", "required": false, - "type": "date" - }, + "type": "uuid" + } + ], + "response": [ + {}, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "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": "Lists implementors of implementor of a network traffic type or implementors of all network traffic types", + "isasync": false, + "name": "listTrafficTypeImplementors", + "params": [ { "description": "", "length": 255, @@ -120421,482 +134996,764 @@ "type": "integer" }, { - "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the system VM.", + "description": "List by keyword", "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,deployVnfAppliance,importVm", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", "length": 255, - "name": "page", + "name": "traffictype", "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "network traffic type", + "name": "traffictype", + "type": "string" + }, + {}, + { + "description": "implementor of network traffic type", + "name": "traffictypeimplementor", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" } ], + "since": "3.0.0" + }, + { + "description": "list the db hosts and statistics", + "isasync": false, + "name": "listDbMetrics", + "params": [], "related": "", "response": [ + { + "description": "the version of the currently running DB", + "name": "version", + "type": "string" + }, + { + "description": "the state of the usage server", + "name": "replicas", + "type": "string[]" + }, + { + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" + }, + { + "description": "the name of the active usage server", + "name": "hostname", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the number of connections to the DB", + "name": "connections", + "type": "int" + }, + { + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", "type": "string" }, + {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the version of the currently running DB", + "name": "versioncomment", "type": "string" }, + { + "description": "the number of queries performed on the DB", + "name": "queries", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "the last measured load averages on the DB", + "name": "dbloadaverages", + "type": "double[]" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" + "description": "the uptime of the DB in seconds", + "name": "uptime", + "type": "long" } ], - "since": "4.18.0" + "since": "4.17.0" }, { - "description": "Deletes a IPv6 firewall rule", - "isasync": true, - "name": "deleteIpv6FirewallRule", + "description": "Deletes an image store or Secondary Storage.", + "isasync": false, + "name": "deleteImageStore", "params": [ { - "description": "the ID of the IPv6 firewall rule", + "description": "The image store ID or Secondary Storage ID.", "length": 255, "name": "id", - "related": "", + "related": "listSwifts", "required": true, "type": "uuid" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" } - ] + ], + "since": "4.2.0" }, { - "description": "Creates a physical network", - "isasync": true, - "name": "createPhysicalNetwork", + "description": "Lists autoscale vm profiles.", + "isasync": false, + "name": "listAutoScaleVmProfiles", "params": [ { - "description": "the name of the physical network", + "description": "", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "networkspeed", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic", + "description": "the otherdeployparameters of the autoscale vm profile", "length": 255, - "name": "broadcastdomainrange", + "name": "otherdeployparams", "required": false, "type": "string" }, { - "description": "the isolation method for the physical network[VLAN/L3/GRE]", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isolationmethods", + "name": "fordisplay", "required": false, - "type": "list" + "since": "4.4", + "type": "boolean" }, { - "description": "domain ID of the account owning a physical network", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the autoscale vm profile", + "length": 255, + "name": "id", + "related": "listAutoScaleVmProfiles", "required": false, "type": "uuid" }, { - "description": "Tag the physical network", + "description": "List by keyword", "length": 255, - "name": "tags", + "name": "keyword", "required": false, - "type": "list" + "type": "string" }, { - "description": "the VLAN for the physical network", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "vlan", + "name": "account", "required": false, "type": "string" }, { - "description": "the Zone ID for the physical network", + "description": "availability zone for the auto deployed virtual machine", "length": 255, "name": "zoneid", "related": "listZones", - "required": true, + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the templateid of the autoscale vm profile", + "length": 255, + "name": "templateid", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "list profiles by service offering id", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.4", + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, + {}, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, {}, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "state of the physical network", - "name": "state", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "zone id of the physical network", + "description": "the availability zone to be used while deploying a virtual machine", "name": "zoneid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", + "type": "string" }, { - "description": "name of the physical network", - "name": "name", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the speed of the physical network", - "name": "networkspeed", + "description": "the project name of the vm profile", + "name": "project", + "type": "string" + }, + { + "description": "the autoscale vm profile ID", + "name": "id", + "type": "string" + }, + { + "description": "the project id vm profile", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" + }, + { + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" } - ], - "since": "3.0.0" + ] }, { - "description": "Lists autoscale vm groups.", - "isasync": false, - "name": "listAutoScaleVmGroups", + "description": "Authorizes a particular ingress rule for this security group", + "isasync": true, + "name": "authorizeSecurityGroupIngress", "params": [ { - "description": "", + "description": "type of the icmp message being sent", "length": 255, - "name": "pagesize", + "name": "icmptype", "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 policy", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "policyid", + "name": "securitygroupid", "related": "", "required": false, "type": "uuid" }, { - "description": "the availability zone ID", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "error code for this icmp message", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "icmpcode", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the autoscale vm group", + "description": "user to security group mapping", "length": 255, - "name": "id", - "related": "listAutoScaleVmGroups", + "name": "usersecuritygrouplist", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "start port for this ingress rule", "length": 255, - "name": "account", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the name of the autoscale vmgroup", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "name", + "name": "cidrlist", "required": false, - "since": "4.18.0", - "type": "string" + "type": "list" }, { - "description": "the ID of the loadbalancer", + "description": "an optional project of the security group", "length": 255, - "name": "lbruleid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", "length": 255, - "name": "keyword", + "name": "securitygroupname", "required": false, "type": "string" }, { - "description": "the ID of the profile", - "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "end port for this ingress rule", "length": 255, - "name": "page", + "name": "endport", "required": false, "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "an optional account for the security group. Must be used with domainId.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "the domain name of the vm group", - "name": "domain", + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "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": "the protocol of the security group rule", + "name": "protocol", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ] + }, + { + "description": "Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it)", + "isasync": true, + "name": "syncStoragePool", + "params": [ + { + "description": "Storage pool id", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": true, + "type": "uuid" + } + ], + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", + "response": [ + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + {}, + { + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", - "name": "availablevirtualmachinecount", - "type": "int" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "is group for display to the regular user", - "name": "fordisplay", + "description": "the name of the storage pool", + "name": "name", + "type": "string" + }, + { + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the private port", - "name": "privateport", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the storage pool type", + "name": "type", "type": "string" }, - {}, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, {}, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", + "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 overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { @@ -120905,938 +135762,1028 @@ "type": "boolean" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the tags for the storage pool", + "name": "tags", "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 nfs mount options for the storage pool", + "name": "nfsmountopts", + "type": "string" } - ] + ], + "since": "4.15.1" }, { - "description": "Creates a firewall rule for a given IP address", - "isasync": true, - "name": "createFirewallRule", + "description": "Updates Bucket properties", + "isasync": false, + "name": "updateBucket", "params": [ { - "description": "type of firewallrule: system/user", + "description": "Bucket Access Policy", "length": 255, - "name": "type", + "name": "policy", "required": false, "type": "string" }, { - "description": "the ending port of firewall rule", + "description": "The ID of the Bucket", "length": 255, - "name": "endport", - "required": false, - "type": "integer" + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "Enable/Disable Bucket Versioning", "length": 255, - "name": "fordisplay", + "name": "versioning", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "description": "Enable/Disable Bucket encryption", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "encryption", + "required": false, + "type": "boolean" }, { - "description": "type of the ICMP message being sent", + "description": "Bucket Quota in GB", "length": 255, - "name": "icmptype", + "name": "quota", "required": false, "type": "integer" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "error code for this icmp message", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Recalculate and update resource count for an account or domain. This also executes some cleanup tasks before calculating resource counts.", + "isasync": false, + "name": "updateResourceCount", + "params": [ + { + "description": "Update resource count for a specified account. Must be used with the domainId parameter.", "length": 255, - "name": "icmpcode", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "Tag for the resource type", "length": 255, - "name": "cidrlist", + "name": "tag", "required": false, - "type": "list" + "since": "4.20.0", + "type": "string" }, { - "description": "the IP address id of the port forwarding rule", + "description": "If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,listPublicIpAddresses", + "name": "domainid", + "related": "listDomains", "required": true, "type": "uuid" }, { - "description": "the starting port of firewall rule", + "description": "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of snapshots a user can create. 4 - Template. Number of templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "startport", + "name": "resourcetype", "required": false, "type": "integer" + }, + { + "description": "Update resource limits for project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" } ], - "related": "updateEgressFirewallRule", + "related": "", "response": [ { - "description": "the ID of the firewall rule", - "name": "id", + "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 name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.", + "name": "resourcetypename", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "the 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" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the domain name for which resource count's are updated", + "name": "domain", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "The resource count", + "name": "resourcecount", + "type": "long" }, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "path of the domain to which the resource counts are updated", + "name": "domainpath", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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 traffic type for the firewall rule", - "name": "traffictype", + "description": "the account for which resource count's are updated", + "name": "account", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "Tag for the resource", + "name": "tag", "type": "string" }, { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "list" + "description": "the project name for which resource count's are updated", + "name": "project", + "type": "string" }, + {}, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the domain ID for which resource count's are updated", + "name": "domainid", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {}, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - } + {} ] }, { - "description": "Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.", - "isasync": true, - "name": "createVolume", + "description": "Lists dynamic roles in CloudStack", + "isasync": false, + "name": "listRoles", "params": [ { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the name of the disk volume", + "description": "List role by role name.", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "max iops", + "description": "", "length": 255, - "name": "maxiops", + "name": "page", "required": false, - "type": "long" + "type": "integer" }, { - "description": "Arbitrary volume size", + "description": "List role by role type status, valid options are: enabled, disabled", "length": 255, - "name": "size", + "name": "state", "required": false, - "type": "long" + "type": "string" }, { - "description": "an optional field, whether to display the volume to the end user or not.", + "description": "", "length": 255, - "name": "displayvolume", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation", + "description": "List role by role ID.", "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,deployVnfAppliance,importVm", + "name": "id", + "related": "listRoles", "required": false, "type": "uuid" }, { - "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "type", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "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 state of the role", + "name": "state", + "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" + }, + { + "description": "the ID of the role", + "name": "id", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "list Tungsten-Fabric policy", + "isasync": false, + "name": "listTungstenFabricPolicy", + "params": [ + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": false, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "min iops", + "description": "", "length": 255, - "name": "miniops", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { - "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "description": "the ID of ip address", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", + "description": "the ID of network", "length": 255, - "name": "snapshotid", - "related": "listSnapshots", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "List by keyword", "length": 255, - "name": "customid", + "name": "keyword", "required": false, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, + {} + ] + }, + { + "description": "Download object at a specified path on an image store.", + "isasync": true, + "name": "downloadImageStoreObject", + "params": [ { - "description": "the project associated with the volume. Mutually exclusive with account parameter", + "description": "id of the image store", "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, + "name": "id", + "related": "listSwifts", + "required": true, "type": "uuid" }, { - "description": "the ID of the availability zone", + "description": "path to download on image store", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "path", "required": false, - "type": "uuid" + "type": "string" } ], - "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "related": "extractSnapshot,extractTemplate", "response": [ { - "description": "name of the availability zone", - "name": "zonename", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the name of the extracted object", + "name": "name", "type": "string" }, + { + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "", + "name": "resultstring", + "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 extraction", + "name": "status", + "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "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": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the state of the extracted object", + "name": "state", + "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Retrieves a cloud identifier.", + "isasync": false, + "name": "getCloudIdentifier", + "params": [ + { + "description": "the user ID for the cloud identifier", + "length": 255, + "name": "userid", + "related": "getUser", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the signed response for the cloud identifier", + "name": "signature", + "type": "string" }, + {}, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the cloud identifier", + "name": "cloudidentifier", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the user ID for the cloud identifier", + "name": "userid", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ] + }, + { + "description": "Creates a load balancer stickiness policy ", + "isasync": true, + "name": "createLBStickinessPolicy", + "params": [ + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the bytes actually consumed on disk", - "name": "virtualsize", - "type": "long" + "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", + "length": 255, + "name": "param", + "required": false, + "type": "map" }, { - "description": "the list of resource tags associated", - "name": "tags", + "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 stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", + "length": 255, + "name": "methodname", + "required": true, + "type": "string" + }, + { + "description": "name of the load balancer stickiness policy", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the description of the load balancer stickiness policy", + "length": 255, + "name": "description", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the list of stickinesspolicies", + "name": "stickinesspolicy", "response": [ { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the params of the policy", + "name": "params", + "type": "map" }, { - "description": "tag key name", - "name": "key", + "description": "the method name of the Stickiness policy", + "name": "methodname", "type": "string" } ], - "type": "set" - }, - { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "type": "list" }, + {}, { - "description": "pod id of the volume", - "name": "podid", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, - {}, - { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, { - "description": "the state of the disk volume", + "description": "the state of the policy", "name": "state", "type": "string" }, - { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" - }, {}, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ], + "since": "3.0.0" + }, + { + "description": "Adds a Cisco Asa 1000v appliance", + "isasync": false, + "name": "addCiscoAsa1000vResource", + "params": [ { - "description": "name of the virtual machine", - "name": "vmname", + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Nexus port profile associated with inside interface of ASA 1000v", + "length": 255, + "name": "insideportprofile", + "required": true, "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the Cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + {}, + {}, + {}, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, + {}, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {} + ] + }, + { + "description": "Configures a Palo Alto firewall device", + "isasync": true, + "name": "configurePaloAltoFirewall", + "params": [ { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "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": "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": "Palo Alto firewall device ID", + "length": 255, + "name": "fwdeviceid", + "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", + "required": true, + "type": "uuid" + } + ], + "related": "listPaloAltoFirewalls", + "response": [ { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the bytes allocated", - "name": "physicalsize", - "type": "long" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", - "name": "deviceid", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "device capacity", + "name": "fwdevicecapacity", "type": "long" }, { - "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": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" } ] }, { - "description": "List virtual machine snapshot by conditions", - "isasync": false, - "name": "listVMSnapshot", + "description": "Updates ACL item with specified ID", + "isasync": true, + "name": "updateNetworkACLItem", "params": [ { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "partialupgrade", "required": false, "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "protocol", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The ID of the VM snapshot", + "description": "A description indicating why the ACL rule is required.", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "reason", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the starting port of ACL", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "startport", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "type of the ICMP message being sent", "length": 255, - "name": "account", + "name": "icmptype", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "The network of the vm the ACL will be created for", "length": 255, - "name": "listall", + "name": "number", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "keyword", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { - "description": "", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "page", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { - "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", + "description": "error code for this ICMP message", "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", + "name": "icmpcode", "required": false, - "since": "4.9", - "type": "list" + "type": "integer" }, { - "description": "state of the virtual machine snapshot", + "description": "scl entry action, allow or deny", "length": 255, - "name": "state", + "name": "action", "required": false, "type": "string" }, { - "description": "lists snapshot by snapshot name or display name", + "description": "the ending port of ACL", "length": 255, - "name": "name", + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "pagesize", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the vm", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "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,deployVnfAppliance,importVm", + "name": "customid", "required": false, - "type": "uuid" + "since": "4.4", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the ID of the network ACL item", "length": 255, - "name": "tags", - "required": false, - "type": "map" + "name": "id", + "related": "updateNetworkACLItem,moveNetworkAclItem", + "required": true, + "type": "uuid" } ], - "related": "createVMSnapshot", + "related": "moveNetworkAclItem", "response": [ { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "the Zone name of the vm snapshot", - "name": "zonename", - "type": "string" - }, - { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", - "type": "string" - }, - { - "description": "the description of the vm snapshot", - "name": "description", - "type": "string" - }, - { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the display name of the vm snapshot", - "name": "displayname", - "type": "string" - }, - { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", - "type": "string" + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" }, { - "description": "the ID of the vm snapshot", + "description": "the ID of the ACL Item", "name": "id", "type": "string" }, { - "description": "VM Snapshot type", - "name": "type", - "type": "string" - }, - { - "description": "the parent ID of the vm snapshot", - "name": "parent", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the list of resource tags associated", + "description": "the list of resource tags associated with the network ACLs", "name": "tags", "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", @@ -121848,13 +136795,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -121862,752 +136809,1029 @@ "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", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { "description": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], - "type": "set" + "type": "list" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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" + }, + { + "description": "Number of the ACL Item", + "name": "number", "type": "integer" }, + { + "description": "the ending port of ACL's port range", + "name": "endport", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the name of the vm snapshot", - "name": "name", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the protocol of the ACL", + "name": "protocol", + "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + {}, + { + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" } - ], - "since": "4.2.0" + ] }, { - "description": "Updates a Pod.", + "description": "List routers.", "isasync": false, - "name": "updatePod", + "name": "listRouters", "params": [ { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "allocationstate", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ending IP address for the Pod", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "endip", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List networks by VPC", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "the name of the Pod", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "the gateway for the Pod", + "description": "the host ID of the router", "length": 255, - "name": "gateway", + "name": "hostid", + "related": "reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "the Pod ID of the router", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "the Zone ID of the router", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "list virtual router elements by version", + "length": 255, + "name": "version", "required": false, "type": "string" }, { - "description": "the netmask of the Pod", + "description": "if true is passed for this parameter, list only VPC routers", "length": 255, - "name": "netmask", + "name": "forvpc", + "required": false, + "type": "boolean" + }, + { + "description": "the state of the router", + "length": 255, + "name": "state", "required": false, "type": "string" }, { - "description": "the starting IP address for the Pod", + "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", "length": 255, - "name": "startip", + "name": "fetchhealthcheckresults", + "required": false, + "since": "4.14", + "type": "boolean" + }, + { + "description": "the name of the router", + "length": 255, + "name": "name", "required": false, "type": "string" }, { - "description": "the ID of the Pod", + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "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 ID of the disk router", "length": 255, "name": "id", - "related": "updatePod,createManagementNetworkIpRange", - "required": true, + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "if this parameter is passed, list only routers by health check results", + "length": 255, + "name": "healthchecksfailed", + "required": false, + "since": "4.16", + "type": "boolean" + }, + { + "description": "list by network id", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "the cluster ID of the router", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, "type": "uuid" } ], - "related": "createManagementNetworkIpRange", + "related": "", "response": [ - {}, { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - } - ], - "type": "list" + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" }, { - "description": "the name of the Pod", - "name": "name", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, + {}, { - "description": "the Zone name of the Pod", + "description": "the Zone name for the router", "name": "zonename", "type": "string" }, { - "description": "the ID of the Pod", - "name": "id", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" - }, - { - "description": "the capacity of the Pod", - "name": "capacity", + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "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" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "result of the health check", + "name": "success", + "type": "boolean" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Zone name", - "name": "zonename", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "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": "the name of the router", + "name": "name", + "type": "string" }, - {}, { - "description": "the gateway of the Pod", - "name": "gateway", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "the version of scripts", + "name": "scriptsversion", "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 Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - } - ] - }, - { - "description": "Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list", - "isasync": true, - "name": "moveNetworkAclItem", - "params": [ - { - "description": "The ID of the network ACL rule that is being moved to a new position.", - "length": 255, - "name": "id", - "required": true, + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "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, + "description": "the second DNS for the router", + "name": "dns2", "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", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", - "length": 255, - "name": "aclconsistencyhash", - "required": false, - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", - "length": 255, - "name": "previousaclruleid", - "required": false, + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "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 account associated with the router", + "name": "account", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "path of the Domain the router belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, + {}, { - "description": "the list of resource tags associated with the network ACLs", - "name": "tags", + "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 list of nics associated with the router", + "name": "nic", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "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 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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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 IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" } ], - "type": "list" + "type": "set" }, - {}, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" - } - ] - }, - { - "description": "Attaches an ISO to a virtual machine.", - "isasync": true, - "name": "attachIso", - "params": [ - { - "description": "If true, ejects existing ISO before attaching on VMware. Default: false", - "length": 255, - "name": "forced", - "required": false, - "since": "4.15.1", - "type": "boolean" + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { - "description": "the ID of the ISO file", - "length": 255, + "description": "the id of the router", "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "type": "string" }, { - "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,deployVnfAppliance,importVm", - "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,deployVnfAppliance,importVm", - "response": [ - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" + } + ] + }, + { + "description": "list Tungsten-Fabric vm", + "isasync": false, + "name": "listTungstenFabricVm", + "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the uuid of Tungsten-Fabric vm", + "length": 255, + "name": "vmuuid", + "required": false, "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ + {}, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "Tungsten-Fabric nic uuid", + "name": "uuid", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Tungsten-Fabric vm name", + "name": "name", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Deletes a Physical Network.", + "isasync": true, + "name": "deletePhysicalNetwork", + "params": [ + { + "description": "the ID of the Physical network", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } + ], + "since": "3.0.0" + }, + { + "description": "add Tungsten-Fabric policy rule", + "isasync": true, + "name": "addTungstenFabricPolicyRule", + "params": [ { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "Tungsten-Fabric policy rule source network", + "length": 255, + "name": "srcnetwork", + "required": true, "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Tungsten-Fabric policy rule source ip prefix", + "length": 255, + "name": "srcipprefix", + "required": true, + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Tungsten-Fabric policy rule source start port", + "length": 255, + "name": "srcstartport", + "required": true, + "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "Tungsten-Fabric policy rule destination start port", + "length": 255, + "name": "deststartport", + "required": true, + "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "Tungsten-Fabric policy rule destination end port", + "length": 255, + "name": "destendport", + "required": true, + "type": "integer" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "Tungsten-Fabric policy rule destination ip prefix", + "length": 255, + "name": "destipprefix", + "required": true, "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "Tungsten-Fabric policy rule action", + "length": 255, + "name": "action", + "required": true, "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "Tungsten-Fabric policy rule source end port", + "length": 255, + "name": "srcendport", + "required": true, + "type": "integer" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Tungsten-Fabric policy rule protocol", + "length": 255, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Tungsten-Fabric policy rule direction", + "length": 255, + "name": "direction", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric policy rule destination network", + "length": 255, + "name": "destnetwork", + "required": true, + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "Tungsten-Fabric policy rule source ip prefix length", + "length": 255, + "name": "srcipprefixlen", + "required": true, + "type": "integer" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, + "description": "Tungsten-Fabric policy rule destination ip prefix length", + "length": 255, + "name": "destipprefixlen", + "required": true, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", + "type": "int" }, + {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", "type": "string" }, - {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "Tungsten-Fabric policy name", + "name": "direction", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" }, { "description": "the UUID of the latest async job acting on this object", @@ -122615,826 +137839,378 @@ "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", "type": "string" - }, + } + ] + }, + { + "description": "Creates a Webhook", + "isasync": false, + "name": "createWebhook", + "params": [ { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Secret key of the Webhook", + "length": 255, + "name": "secretkey", + "required": false, "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Name for the Webhook", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Scope of the Webhook", + "length": 255, + "name": "scope", + "required": false, + "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "An optional account for the Webhook. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "an optional domainId for the Webhook. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, - {}, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "If set to true then SSL verification will be done for the Webhook otherwise not", + "length": 255, + "name": "sslverification", + "required": false, + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Project for the Webhook", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "Description for the Webhook", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "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 type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "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 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" - } - ], - "type": "set" + "description": "Payload URL of the Webhook", + "length": 255, + "name": "payloadurl", + "required": true, + "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": "State of the Webhook", + "length": 255, + "name": "state", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", + "type": "string" }, + {}, + {}, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - } - ], - "type": "set" + "description": "The secret key for the Webhook", + "name": "secretkey", + "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the project id of the Kubernetes cluster", + "name": "projectid", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.20.0" + }, + { + "description": "Removes vpn user", + "isasync": true, + "name": "removeVpnUser", + "params": [ + { + "description": "username for the vpn user", + "length": 255, + "name": "username", + "required": true, "type": "string" }, - {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "an optional account for the vpn user. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "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 ID of the security group", - "name": "id", - "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "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 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": "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 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": "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" - } - ], - "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": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "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": "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": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "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": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "remove vpn user from the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, + {} + ] + }, + { + "description": "List public IP addresses in quarantine.", + "isasync": false, + "name": "listQuarantinedIps", + "params": [ { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project 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 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 key name", - "name": "key", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "Show IPs that are no longer in quarantine.", + "length": 255, + "name": "showinactive", + "required": false, "type": "boolean" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Show IPs removed from quarantine.", + "length": 255, + "name": "showremoved", + "required": false, + "type": "boolean" + } + ], + "related": "updateQuarantinedIp", + "response": [ + { + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The public IP address in quarantine.", + "name": "ipaddress", + "type": "string" + }, + { + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", + "type": "string" + }, + { + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", + "type": "string" + }, + {}, + { + "description": "ID of the quarantine process.", + "name": "id", + "type": "string" + }, + { + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "When the quarantine was created.", + "name": "created", + "type": "date" + }, + {}, + { + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", + "type": "string" } - ] + ], + "since": "4.19" }, { - "description": "Disassociates an IP address from the account.", + "description": "Deletes a load balancer health check policy.", "isasync": true, - "name": "disassociateIpAddress", + "name": "deleteLBHealthCheckPolicy", "params": [ { - "description": "IP Address to be disassociated. Mutually exclusive with the id parameter", - "length": 255, - "name": "ipaddress", - "required": false, - "since": "4.19.0", - "type": "string" - }, - { - "description": "the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter", + "description": "the ID of the load balancer health check policy", "length": 255, "name": "id", - "related": "associateIpAddress,listPublicIpAddresses", - "required": false, + "related": "", + "required": true, "type": "uuid" } ], @@ -123455,326 +138231,550 @@ "name": "success", "type": "boolean" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} - ] + } + ], + "since": "4.2.0" }, { - "description": "list baremetal dhcp servers", + "description": "List Swift.", "isasync": false, - "name": "listBaremetalDhcp", + "name": "listSwifts", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "Type of DHCP device", + "description": "", "length": 255, - "name": "dhcpservertype", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "DHCP server device ID", + "description": "the id of the swift", "length": 255, "name": "id", "required": false, "type": "long" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" + }, + { + "description": "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, {}, { - "description": "name of the provider", - "name": "dhcpservertype", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "url", + "description": "the provider name of the image store", + "name": "providername", + "type": "string" + }, + { + "description": "the url of the image store", "name": "url", "type": "string" }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, + {} + ], + "since": "3.0.0" + }, + { + "description": "Disables HA for a host", + "isasync": true, + "name": "disableHAForHost", + "params": [ + { + "description": "ID of the host", + "length": 255, + "name": "hostid", + "related": "reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "device id of ", - "name": "id", + "description": "if host HA is enabled for the host", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the host HA provider", + "name": "haprovider", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "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": "operation status", + "name": "status", + "type": "boolean" + }, + { + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" } - ] + ], + "since": "4.11" }, { - "description": "Puts storage pool into maintenance state", + "description": "Enables out-of-band management for a host", "isasync": true, - "name": "enableStorageMaintenance", + "name": "enableOutOfBandManagementForHost", "params": [ { - "description": "Primary storage ID", + "description": "the ID of the host", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,enableStorageMaintenance", + "name": "hostid", + "related": "reconnectHost", "required": true, "type": "uuid" } ], - "related": "cancelStorageMaintenance", + "related": "", "response": [ { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the out-of-band management interface powerState of the host", + "name": "powerstate", + "type": "powerstate" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the operation result description", + "name": "description", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "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 total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "the operation result", + "name": "status", "type": "boolean" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the Zone ID of the storage pool", + "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" + }, + { + "description": "the out-of-band management interface address", + "name": "address", + "type": "string" + }, + { + "description": "the out-of-band management interface username", + "name": "username", + "type": "string" + } + ], + "since": "4.9.0" + }, + { + "description": "Deletes a service offering.", + "isasync": false, + "name": "deleteServiceOffering", + "params": [ + { + "description": "the ID of the service offering", + "length": 255, + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + } + ], + "response": [ + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Lists supported Kubernetes version", + "isasync": false, + "name": "listKubernetesSupportedVersions", + "params": [ + { + "description": "the ID of the zone in which Kubernetes supported version will be available", + "length": 255, "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "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": "the ID of the Kubernetes supported version", + "length": 255, + "name": "id", + "related": "listKubernetesSupportedVersions", + "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": "the ID of the minimum Kubernetes supported version", + "length": 255, + "name": "minimumkubernetesversionid", + "related": "listKubernetesSupportedVersions", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", + "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", + "type": "string" }, { - "description": "the name of the storage pool", + "description": "Name of the Kubernetes supported version", "name": "name", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", - "type": "string" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "the storage pool path", - "name": "path", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, + {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the id of the Kubernetes supported version", + "name": "id", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, - {}, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" + }, + { + "description": "KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { - "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 scope of the storage pool", - "name": "scope", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Adds a Nicira NVP device", + "isasync": true, + "name": "addNiciraNvpDevice", + "params": [ { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "Credentials to access the Nicira Controller API", + "length": 255, + "name": "username", + "required": true, + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "The L2 Gateway Service UUID configured on the Nicira Controller", + "length": 255, + "name": "l2gatewayserviceuuid", + "required": false, "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "Hostname of ip address of the Nicira NVP Controller.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "Credentials to access the Nicira Controller API", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "The L3 Gateway Service UUID configured on the Nicira Controller", + "length": 255, + "name": "l3gatewayserviceuuid", + "required": false, + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The Transportzone UUID configured on the Nicira Controller", + "length": 255, + "name": "transportzoneuuid", + "required": true, "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Removes an existing secondary storage selector.", - "isasync": false, - "name": "removeSecondaryStorageSelector", - "params": [ { - "description": "The unique identifier of the secondary storage selector to be removed.", + "description": "the Physical Network ID", "length": 255, - "name": "id", - "related": "removeSecondaryStorageSelector", + "name": "physicalnetworkid", + "related": "", "required": true, "type": "uuid" } ], "related": "", "response": [ + {}, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" - }, - { - "description": "ID of the heuristic.", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name of the heuristic.", - "name": "name", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, - {}, - {}, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "device name", + "name": "niciradevicename", "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" }, { - "description": "Description of the heuristic.", - "name": "description", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, { - "description": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, + {}, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" + "description": "the transport zone Uuid", + "name": "transportzoneuuid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -123782,29 +138782,39 @@ "type": "integer" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "type": "string" } - ], - "since": "4.19.0" + ] }, { - "description": "(Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site.", + "description": "Lists infrastructure", "isasync": false, - "name": "ldapRemove", + "name": "listInfrastructure", "params": [], "related": "", "response": [ + {}, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", - "type": "string" + "description": "Number of Alerts", + "name": "alerts", + "type": "integer" }, { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", - "type": "string" + "description": "Number of routers", + "name": "routers", + "type": "integer" + }, + { + "description": "Number of object stores", + "name": "objectstores", + "type": "integer" }, { "description": "the current status of the latest async job acting on this object", @@ -123812,82 +138822,121 @@ "type": "integer" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", - "type": "string" + "description": "Number of zones", + "name": "zones", + "type": "integer" }, - {}, { - "description": "DN password", - "name": "bindpass", - "type": "string" + "description": "Number of management servers", + "name": "managementservers", + "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" + "description": "Number of hypervisor hosts", + "name": "hosts", + "type": "integer" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", - "name": "hostname", - "type": "string" + "description": "Number of systemvms", + "name": "systemvms", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + "description": "Number of clusters", + "name": "clusters", + "type": "integer" + }, + { + "description": "Number of pods", + "name": "pods", + "type": "integer" + }, + { + "description": "Number of cpu sockets", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "Number of images stores", + "name": "imagestores", + "type": "integer" + }, + { + "description": "Number of internal LBs", + "name": "ilbvms", + "type": "integer" + }, + { + "description": "Number of storage pools", + "name": "storagepools", + "type": "integer" + }, + {} ], - "since": "3.0.1" + "since": "4.9.3" }, { - "description": "Creates a user for an account that already exists", + "description": "Lists usage records for accounts", "isasync": false, - "name": "createUser", + "name": "listUsageRecords", "params": [ { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "", "length": 255, - "name": "account", - "required": true, - "type": "string" + "name": "page", + "required": false, + "type": "integer" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", "length": 255, - "name": "timezone", + "name": "usageid", "required": false, "type": "string" }, { - "description": "lastname", + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", "length": 255, - "name": "lastname", - "required": true, - "type": "string" + "name": "oldformat", + "required": false, + "type": "boolean" }, { - "description": "firstname", + "description": "List by keyword", "length": 255, - "name": "firstname", - "required": true, + "name": "keyword", + "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.", + "description": "", "length": 255, - "name": "password", - "required": true, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "length": 255, + "name": "isrecursive", + "required": false, + "since": "4.15", + "type": "boolean" + }, + { + "description": "List usage records for the specified user.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "description": "List usage records for the specified domain.", "length": 255, "name": "domainid", "related": "listDomains", @@ -123895,139 +138944,121 @@ "type": "uuid" }, { - "description": "email", + "description": "End date range for usage record query. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"23:59:59\"). If the recommended format is not used, the date will be considered in the server timezone.", "length": 255, - "name": "email", + "name": "enddate", "required": true, - "type": "string" + "type": "date" }, { - "description": "Unique username.", + "description": "Flag to enable display of Tags for a resource", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "includetags", + "required": false, + "type": "boolean" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "List usage records for the specified usage type", "length": 255, - "name": "userid", + "name": "type", "required": false, - "type": "string" - } - ], - "related": "getUser", - "response": [ - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "type": "long" }, { - "description": "the date and time the user account was created", - "name": "created", + "description": "Start date range for usage record query. The recommended format is \"yyyy-MM-dd'T'HH:mm:ssZ\" (e.g.: \"2023-01-01T12:00:00+0100\"); however, the following formats are also accepted: \"yyyy-MM-dd HH:mm:ss\" (e.g.: \"2023-01-01 12:00:00\") and \"yyyy-MM-dd\" (e.g.: \"2023-01-01\" - if the time is not added, it will be interpreted as \"00:00:00\"). If the recommended format is not used, the date will be considered in the server timezone.", + "length": 255, + "name": "startdate", + "required": true, "type": "date" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "List usage records for the specified account", + "length": 255, + "name": "accountid", + "related": "enableAccount,listAccounts", + "required": false, + "type": "uuid" }, { - "description": "the user name", - "name": "username", - "type": "string" - }, + "description": "List usage records for specified project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the domain ID of the user", + "description": "the domain ID", "name": "domainid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", + "description": "path of the domain to which the usage reocrd belongs", + "name": "domainpath", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "rolename", + "description": "the project id of the resource", + "name": "projectid", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "speed of each cpu of resource", + "name": "cpuspeed", + "type": "long" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the project name of the resource", + "name": "project", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "virtual machine os type ID", + "name": "ostypeid", "type": "string" }, - {}, { - "description": "the user email address", - "name": "email", + "description": "virtual machine os category name", + "name": "oscategoryname", "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", + "type": "boolean" }, { - "description": "the account name of the user", - "name": "account", + "description": "virtual machine os display name", + "name": "osdisplayname", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the type of the role", - "name": "roletype", + "description": "the domain the resource is associated with", + "name": "domain", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "virtual machine ID", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user account Id", + "name": "accountid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "memory allocated for the resource", + "name": "memory", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -124035,492 +139066,371 @@ "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - {}, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - } - ] - }, - { - "description": "lists all available apis on the server, provided by the Api Discovery plugin", - "isasync": false, - "name": "listApis", - "params": [ - { - "description": "API name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the name of the api command", - "name": "name", + "description": "raw usage in hours", + "name": "rawusage", "type": "string" }, { - "description": "comma separated related apis", - "name": "related", + "description": "template ID", + "name": "templateid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "start date of the usage record", + "name": "startdate", + "type": "date" }, - {}, { - "description": "description of the api", - "name": "description", - "type": "string" + "description": "end date of the usage record", + "name": "enddate", + "type": "date" }, { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "resource type", + "name": "type", "type": "string" }, - {}, { - "description": "true if api is asynchronous", - "name": "isasync", - "type": "boolean" + "description": "virtual size of resource", + "name": "virtualsize", + "type": "long" }, { - "description": "the list params the api accepts", - "name": "params", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "comma separated related apis to get the parameter", - "name": "related", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "description of the api parameter", - "name": "description", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "length of the parameter", - "name": "length", - "type": "int" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "true if this parameter is required for the api request", - "name": "required", - "type": "boolean" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "parameter type", - "name": "type", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the name of the api parameter", - "name": "name", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" - } - ], - "type": "set" - }, - { - "description": "response field type", - "name": "type", - "type": "string" - }, - { - "description": "api response fields", - "name": "response", - "response": [ + }, { - "description": "response field type", - "name": "type", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "description of the api response field", - "name": "description", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "api response fields", - "name": "response", - "type": "set" + "description": "id of the resource", + "name": "resourceid", + "type": "string" }, { - "description": "the name of the api response field", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" - } - ], - "since": "4.1.0" - }, - { - "description": "deletes baremetal rack configuration text", - "isasync": true, - "name": "deleteBaremetalRct", - "params": [ + }, + {}, { - "description": "RCT id", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "the user account name", + "name": "account", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "resource or virtual machine name", + "name": "name", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "True if the IPAddress is system IP - allocated during vm deploy or lb rule create", + "name": "issystem", "type": "boolean" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "offering ID", + "name": "offeringid", "type": "string" - } - ] - }, - { - "description": "Creates site to site vpn local gateway", - "isasync": true, - "name": "createVpnGateway", - "params": [ - { - "description": "an optional field, whether to the display the vpn to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" }, { - "description": "public ip address id of the vpn gateway", - "length": 255, + "description": "id of the vpc", "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "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 domain name of the owner", - "name": "domain", + "description": "id of the network", + "name": "networkid", "type": "string" }, + {}, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the zone ID", + "name": "zoneid", "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", + "description": "True if the resource is default", + "name": "isdefault", "type": "boolean" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the owner", - "name": "account", + "description": "usage in hours", + "name": "usage", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "usage type ID", + "name": "usagetype", + "type": "integer" }, { - "description": "the vpn gateway ID", - "name": "id", + "description": "description of the usage record", + "name": "description", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", - "type": "string" + "description": "number of cpu of resource", + "name": "cpunumber", + "type": "long" }, { - "description": "the project name", - "name": "project", + "description": "virtual machine guest os category ID", + "name": "oscategoryid", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "id of the resource", + "name": "usageid", "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", - "type": "string" - }, - {} + "description": "resource size", + "name": "size", + "type": "long" + } ] }, { - "description": "Creates snapshot for a vm.", - "isasync": true, - "name": "createVMSnapshot", + "description": "Recovers a Destroy volume.", + "isasync": false, + "name": "recoverVolume", "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", - "required": false, - "type": "string" - }, - { - "description": "snapshot memory if true", - "length": 255, - "name": "snapshotmemory", - "required": false, - "type": "boolean" - }, - { - "description": "quiesce vm if true", - "length": 255, - "name": "quiescevm", - "required": false, - "type": "boolean" - }, - { - "description": "The ID of the vm", + "description": "The ID of the volume", "length": 255, - "name": "virtualmachineid", - "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "name": "id", + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, "type": "uuid" } ], - "related": "", + "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", - "type": "string" + "description": "the list of resource tags associated", + "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 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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, {}, { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the create date of the vm snapshot", - "name": "created", + "description": "the date the volume was attached to a VM instance", + "name": "attached", "type": "date" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "indicates if this is current snapshot", - "name": "current", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" + "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": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, - {}, { - "description": "the description of the vm snapshot", - "name": "description", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the name of the vm snapshot", - "name": "name", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the ID of the vm snapshot", - "name": "id", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, + {}, { - "description": "VM Snapshot type", + "description": "type of the disk volume (ROOT or DATADISK)", "name": "type", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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": "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" - } - ], - "type": "set" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "name of the disk volume", + "name": "name", "type": "string" }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "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", @@ -124530,432 +139440,323 @@ "description": "the domain associated with the disk volume", "name": "domain", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Adds detail for the Resource.", - "isasync": true, - "name": "addResourceDetail", - "params": [ + }, { - "description": "Map of (key/value pairs)", - "length": 255, - "name": "details", - "required": true, - "type": "map" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "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": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "resource id to create the details for", - "length": 255, - "name": "resourceid", - "required": true, - "type": "string" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists vpn users", - "isasync": false, - "name": "listVpnUsers", - "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": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "The uuid of the Vpn user", - "length": 255, + "description": "ID of the disk volume", "name": "id", - "related": "addVpnUser,listVpnUsers", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the username of the vpn user.", - "length": 255, - "name": "username", - "required": false, + "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": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" - } - ], - "related": "addVpnUser", - "response": [ + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the username of the vpn user", - "name": "username", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, - {}, { - "description": "the domain id of the account of the remote access vpn", + "description": "the ID of the domain associated with the disk volume", "name": "domainid", "type": "string" }, { - "description": "the vpn userID", - "name": "id", - "type": "string" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, - {} - ] - }, - { - "description": "Deletes an internal load balancer", - "isasync": true, - "name": "deleteLoadBalancer", - "params": [ { - "description": "the ID of the Load Balancer", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "shared or local storage", + "name": "storagetype", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.2.0" - }, - { - "description": "Deletes an IP forwarding rule", - "isasync": true, - "name": "deleteIpForwardingRule", - "params": [ - { - "description": "the ID of the forwarding rule", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - } - ], - "response": [ + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, - {}, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the project name of the vpn", + "name": "project", "type": "string" - } - ] - }, - { - "description": "Register a new userdata.", - "isasync": false, - "name": "registerUserData", - "params": [ + }, { - "description": "Name of the userdata", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "Userdata content", - "length": 1048576, - "name": "userdata", - "required": true, + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" }, { - "description": "an optional account for the userdata. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "an optional project for the userdata", - "length": 255, - "name": "projectid", - "related": "activateProject", - "required": false, - "type": "uuid" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "comma separated list of variables declared in userdata content", - "length": 255, - "name": "params", - "required": false, + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" - } - ], - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" } ], - "since": "4.18" + "since": "4.14.0" }, { - "description": "Adds a Region", - "isasync": false, - "name": "addRegion", + "description": "remove Tungsten-Fabric network gateway from logical router", + "isasync": true, + "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "params": [ { - "description": "Name of the region", + "description": "the ID of zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Region service endpoint", + "description": "Tungsten-Fabric network uuid", "length": 255, - "name": "endpoint", + "name": "networkuuid", "required": true, "type": "string" }, { - "description": "Id of the Region", + "description": "Tungsten-Fabric logical router uuid", "length": 255, - "name": "id", + "name": "logicalrouteruuid", "required": true, - "type": "integer" + "type": "string" } ], "related": "", "response": [ { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "type": "boolean" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {}, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the end point of the region", - "name": "endpoint", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the name of the region", + "description": "Tungsten-Fabric logical router name", "name": "name", "type": "string" }, { - "description": "the ID of the region", - "name": "id", - "type": "integer" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "type": "string" }, { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" } ] }, { - "description": "Lists Tungsten-Fabric tags", + "description": "Lists unmanaged volumes on a storage pool", "isasync": false, - "name": "listTungstenFabricTagType", + "name": "listVolumesForImport", "params": [ { "description": "", @@ -124965,11 +139766,18 @@ "type": "integer" }, { - "description": "the ID of zone", + "description": "the path of the volume on the storage pool", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "path", "required": false, + "type": "string" + }, + { + "description": "the ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", + "required": true, "type": "uuid" }, { @@ -124979,13 +139787,6 @@ "required": false, "type": "integer" }, - { - "description": "the uuid of Tungsten-Fabric tag type", - "length": 255, - "name": "tagtypeuuid", - "required": false, - "type": "string" - }, { "description": "List by keyword", "length": 255, @@ -124997,71 +139798,59 @@ "related": "", "response": [ { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the format of the volume", + "name": "format", + "type": "string" + }, + { + "description": "volume details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of the volume", + "name": "name", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the virtual size of the volume", + "name": "virtualsize", "type": "long" }, { - "description": "Tungsten-Fabric tag type name", - "name": "name", + "description": "id of the primary storage hosting the volume", + "name": "storageid", "type": "string" }, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - } - ] - }, - { - "description": "Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed", - "isasync": false, - "name": "generateUsageRecords", - "params": [ - { - "description": "List events for the specified domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the size of the volume", + "name": "size", + "type": "long" }, { - "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": "name of the primary storage hosting the volume", + "name": "storage", + "type": "string" }, { - "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", - "required": true, - "type": "date" - } - ], - "response": [ + "description": "the encrypt format of the volume", + "name": "encryptformat", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the full path of the volume", + "name": "fullpath", "type": "string" }, { @@ -125070,470 +139859,270 @@ "type": "integer" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the path of the volume", + "name": "path", + "type": "string" }, {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "type of the primary storage hosting the volume", + "name": "storagetype", "type": "string" } - ] + ], + "since": "4.19.1" }, { - "description": "Updates a role permission order", + "description": "Lists zone metrics", "isasync": false, - "name": "updateRolePermission", + "name": "listZonesMetrics", "params": [ { - "description": "Role permission rule id", + "description": "the network type of the zone that the virtual machine belongs to", "length": 255, - "name": "ruleid", - "related": "", + "name": "networktype", "required": false, - "since": "4.11", - "type": "uuid" + "type": "string" }, { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", + "description": "", "length": 255, - "name": "ruleorder", - "related": "", + "name": "page", "required": false, - "type": "list" + "type": "integer" }, { - "description": "Rule permission, can be: allow or deny", + "description": "the ID of the zone", "length": 255, - "name": "permission", + "name": "id", + "related": "listZones", "required": false, - "since": "4.11", - "type": "string" - }, - { - "description": "ID of the role", - "length": 255, - "name": "roleid", - "related": "", - "required": true, "type": "uuid" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.9.0" - }, - { - "description": "List registered keypairs", - "isasync": false, - "name": "listSSHKeyPairs", - "params": [ { - "description": "A key pair name to look for", + "description": "the name of the zone", "length": 255, "name": "name", "required": false, "type": "string" }, { - "description": "A public key fingerprint to look for", - "length": 255, - "name": "fingerprint", - "required": false, - "type": "string" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the IDs of the zones, mutually exclusive with id", "length": 255, - "name": "pagesize", + "name": "ids", + "related": "listZones", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "list" }, { - "description": "the ID of the ssh keypair", + "description": "the ID of the domain associated with the zone", "length": 255, - "name": "id", - "related": "listSSHKeyPairs", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "List zones by resource tags (key/value pairs)", "length": 255, - "name": "listall", + "name": "tags", "required": false, - "type": "boolean" + "since": "4.3", + "type": "map" }, { - "description": "List by keyword", + "description": "flag to display the resource image for the zones", "length": 255, - "name": "keyword", + "name": "showicon", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "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": "account", + "name": "available", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "flag to display the capacity of the zones", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "showcapacities", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "", "response": [ { - "description": "Name of the keypair", - "name": "name", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, + {}, { - "description": "the project id of the keypair owner", - "name": "projectid", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", "type": "boolean" }, { - "description": "ID of the ssh keypair", - "name": "id", - "type": "string" - }, - { - "description": "the project name of the keypair owner", - "name": "project", - "type": "string" - }, - { - "description": "the owner of the keypair", - "name": "account", - "type": "string" - }, - { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" - }, - { - "description": "the domain id of the keypair owner", - "name": "domainid", - "type": "string" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ] - }, - { - "description": "Lists accounts and provides detailed account information for listed accounts", - "isasync": false, - "name": "listAccounts", - "params": [ - { - "description": "list accounts by cleanuprequired attribute (values are true or false)", - "length": 255, - "name": "iscleanuprequired", - "required": false, - "type": "boolean" - }, - { - "description": "flag to display the resource icon for accounts", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" }, { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", - "length": 255, - "name": "accounttype", - "required": false, - "type": "integer" + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", + "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", - "length": 255, - "name": "state", - "required": false, + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", - "length": 255, - "name": "isrecursive", - "required": false, - "type": "boolean" - }, - { - "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", - "length": 255, - "name": "details", - "required": false, - "type": "list" - }, - { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "list account by account ID", - "length": 255, + "description": "Zone id", "name": "id", - "related": "enableAccount,listAccounts,listAccounts", - "required": false, - "type": "uuid" - }, - { - "description": "list account by account name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "enableAccount,listAccounts", - "response": [ - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - }, - { - "description": "the 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 account ID of the user", - "name": "accountid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, - { - "description": "the user email address", - "name": "email", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the user state", - "name": "state", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the account name of the user", - "name": "account", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the Cluster ID", + "name": "clusterid", "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 total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" } ], "type": "list" @@ -125544,1545 +140133,2039 @@ "type": "resourceiconresponse" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "details for the account", - "name": "accountdetails", - "type": "map" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "name of the Domain the account belongs to", + "description": "Network domain name for the networks in the zone", "name": "domain", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "state of the cluster", + "name": "state", "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) the account can own", - "name": "secondarystoragelimit", + "description": "the total cpu used in GiB", + "name": "memoryused", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the type of the zone - core or edge", + "name": "type", "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", "type": "boolean" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", + "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "Zone Token", + "name": "zonetoken", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", + "type": "boolean" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total cpu used in Ghz", + "name": "cpuused", "type": "string" }, - {}, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "Zone name", + "name": "name", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "healthy / total clusters in the zone", + "name": "clusters", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", "type": "integer" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the first internal DNS for the Zone", + "name": "internaldns1", + "type": "string" }, { - "description": "the id of the account", - "name": "id", - "type": "string" + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + } + ], + "since": "4.9.3" + }, + { + "description": "Extracts a template", + "isasync": true, + "name": "extractTemplate", + "params": [ + { + "description": "the ID of the zone where the ISO is originally located", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "length": 255, + "name": "mode", + "required": true, "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the url to which the ISO would be extracted", + "length": 2048, + "name": "url", + "required": false, + "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the ID of the template", + "length": 255, + "name": "id", + "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" + } + ], + "related": "extractSnapshot", + "response": [ + { + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" + }, + { + "description": "the status of the extraction", + "name": "status", "type": "string" }, + {}, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, - {}, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the name of the extracted object", + "name": "name", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "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": "zone ID the object was extracted from", + "name": "zoneid", + "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the id of extracted object", + "name": "id", "type": "string" }, + {}, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Cancels maintenance for primary storage", + "description": "Expunge a virtual machine. Once expunged, it cannot be recoverd.", "isasync": true, - "name": "cancelStorageMaintenance", + "name": "expungeVirtualMachine", "params": [ { - "description": "the primary storage ID", + "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "cancelStorageMaintenance", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", "required": true, "type": "uuid" } ], - "related": "", "response": [ { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, { - "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", + "description": "true if operation is executed successfully", + "name": "success", "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 name of the cluster for the storage pool", - "name": "clustername", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Updates an IP address", + "isasync": true, + "name": "updateIpAddress", + "params": [ + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "an optional field, whether to the display the IP to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the ID of the public IP address to update", + "length": 255, + "name": "id", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, + "type": "uuid" + } + ], + "related": "associateIpAddress,listPublicIpAddresses", + "response": [ + { + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is public IP portable across the zones", + "name": "isportable", "type": "boolean" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value", + "name": "purpose", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, {}, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the domain ID the public IP address is associated with", + "name": "domainid", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, { - "description": "the name of the storage pool", - "name": "name", + "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 ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" }, - {}, { - "description": "the storage pool path", - "name": "path", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, + {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" - } - ] - }, - { - "description": "Destroys a router.", - "isasync": true, - "name": "destroyRouter", - "params": [ + }, { - "description": "the ID of the router", - "length": 255, - "name": "id", - "related": "destroyRouter", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, { - "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 hostname for the router", - "name": "hostname", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the list of resource tags associated with ip address", + "name": "tags", "response": [ { - "description": "the ID of the nic", - "name": "id", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "VPC name the ip belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "type": "string" + }, + { + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" + }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, + { + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + } + ] + }, + { + "description": "moves a network to another physical network", + "isasync": true, + "name": "migrateNetwork", + "params": [ + { + "description": "true if previous network migration cmd failed", + "length": 255, + "name": "resume", + "required": false, + "type": "boolean" + }, + { + "description": "network offering ID", + "length": 255, + "name": "networkofferingid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "the ID of the network", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": true, + "type": "uuid" + } + ], + "related": "createNetwork,updateNetwork,listNetworks", + "response": [ + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "ACL name associated with the VPC network", + "name": "aclname", + "type": "string" + }, + { + "description": "the list of resource tags associated with network", + "name": "tags", + "response": [ { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", + "name": "reservediprange", + "type": "string" + }, + { + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" + }, + { + "description": "the list of services", + "name": "service", + "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "the list of capabilities", + "name": "capability", + "response": [ + { + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + }, + { + "description": "the capability value", + "name": "value", + "type": "string" + } + ], + "type": "list" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" } ], - "type": "set" + "type": "list" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "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", "type": "string" }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" + }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the ID of the Network associated with this network", + "name": "associatednetworkid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the id of the router", - "name": "id", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of the Network associated with this network", + "name": "associatednetwork", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, + {}, { - "description": "role of the domain router", - "name": "role", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the type of the network", + "name": "type", "type": "string" }, + {}, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, + { + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, - {}, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "the version of scripts", - "name": "scriptsversion", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the project id of the ipaddress", + "name": "projectid", "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": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, - {}, - { - "description": "the state of the router", - "name": "state", - "type": "state" - }, { - "description": "the name of the router", - "name": "name", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE", + "name": "networkcidr", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the network domain", + "name": "networkdomain", "type": "string" } - ] + ], + "since": "4.11.0" }, { - "description": "Updates the snapshot policy.", - "isasync": true, - "name": "updateSnapshotPolicy", + "description": "Lists unmanaged virtual machines for a given cluster.", + "isasync": false, + "name": "listUnmanagedInstances", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the hypervisor name of the instance", "length": 255, - "name": "customid", + "name": "name", "required": false, - "since": "4.4", "type": "string" }, { - "description": "the ID of the snapshot policy", + "description": "", "length": 255, - "name": "id", - "related": "updateSnapshotPolicy", + "name": "pagesize", "required": false, + "type": "integer" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": true, "type": "uuid" }, { - "description": "an optional field, whether to the display the snapshot policy to the end user or not.", + "description": "List by keyword", "length": 255, - "name": "fordisplay", + "name": "keyword", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with the virtual machine", + "name": "nic", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the 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 IPv6 network", + "name": "ip6gateway", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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" } ], "type": "set" }, - {}, - { - "description": "the interval type of the snapshot policy", - "name": "intervaltype", - "type": "short" - }, - { - "description": "the ID of the snapshot policy", - "name": "id", - "type": "string" - }, { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "the operating system of the virtual machine", + "name": "osdisplayname", "type": "string" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", + "type": "integer" }, + {}, { - "description": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, - { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" - }, - {}, - { - "description": "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": "Retrieves the current status of asynchronous job.", - "isasync": false, - "name": "queryAsyncJobResult", - "params": [ - { - "description": "the ID of the asynchronous job", - "length": 255, - "name": "jobid", - "related": "queryAsyncJobResult", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", - "type": "long" + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" }, + {}, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" - }, - { - "description": "the domain that executed the async command", - "name": "domainpath", - "type": "string" + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "the domain id that executed the async command", - "name": "domainid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, { - "description": "the current job status-should be 0 for PENDING", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" - }, - { - "description": "the account that executed the async command", - "name": "account", - "type": "string" + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ + { + "description": "the ID of the disk", + "name": "id", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" + }, + { + "description": "the position of the disk", + "name": "position", + "type": "integer" + }, + { + "description": "the controller of the disk", + "name": "datastorepath", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" + }, + { + "description": "the controller of the disk", + "name": "datastorehost", + "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 file path of the disk image", + "name": "imagepath", + "type": "string" + }, + { + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" + }, + { + "description": "the controller of the disk", + "name": "controller", + "type": "string" + } + ], + "type": "set" }, { - "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 progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" - }, - {}, - { - "description": "the async command executed", - "name": "cmd", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" - }, + } + ], + "since": "4.14.0" + }, + { + "description": "Registers an existing template into the CloudStack cloud.", + "isasync": false, + "name": "registerTemplate", + "params": [ { - "description": "the result type", - "name": "jobresulttype", + "description": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, + "type": "boolean" }, { - "description": "the account id that executed the async command", - "name": "accountid", + "description": "the checksum value of this template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "length": 255, + "name": "checksum", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Adds a netscaler control center device", - "isasync": true, - "name": "registerNetscalerControlCenter", - "params": [ - { - "description": "Credentials to reach netscaler controlcenter device", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "password", - "required": true, - "type": "string" + "name": "ispublic", + "required": false, + "type": "boolean" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "true if this template requires HVM", "length": 255, - "name": "numretries", - "required": true, - "type": "integer" + "name": "requireshvm", + "required": false, + "type": "boolean" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "Register template for the project", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "URL of the netscaler controlcenter appliance.", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" - } - ], - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", - "response": [ - { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" + "name": "sshkeyenabled", + "required": false, + "type": "boolean" }, { - "description": "device name", - "name": "lbdevicename", + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "32 or 64 bits support. 64 by default", + "length": 255, + "name": "bits", + "required": false, "type": "integer" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - {}, - { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "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": "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": "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 NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", + "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": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", + "required": false, + "type": "boolean" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the name of the template", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, "type": "boolean" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", - "type": "string" + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "length": 255, + "name": "deployasis", + "required": false, + "since": "4.15.1", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", + "required": false, + "since": "4.19.0", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "The display text of the template, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, - {} - ] - }, - { - "description": "Lists image stores.", - "isasync": false, - "name": "listImageStores", - "params": [ { - "description": "read-only status of the image store", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "readonly", - "related": "listImageStores", + "name": "isextractable", "required": false, - "since": "4.15.0", "type": "boolean" }, { - "description": "", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "pagesize", + "name": "isrouting", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the image store provider", + "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": "provider", + "name": "zoneids", + "related": "listZones", "required": false, - "type": "string" + "type": "list" }, { - "description": "", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "page", + "name": "arch", "required": false, - "type": "integer" + "since": "4.20", + "type": "string" }, { - "description": "the name of the image store", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", "length": 255, - "name": "name", - "required": false, + "name": "format", + "required": true, "type": "string" }, { - "description": "the ID of the storage pool", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "id", - "related": "listImageStores", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" + } + ], + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "response": [ + { + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the Zone ID for the image store", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, { - "description": "the image store protocol", - "length": 255, - "name": "protocol", - "required": false, + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the name of the image store", - "name": "name", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "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": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "the 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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" + }, + { + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "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", + "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 Zone name of the image store", - "name": "zonename", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, - {}, { - "description": "the provider name of the image store", - "name": "providername", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Deletes a account, and all users associated with this account", - "isasync": true, - "name": "deleteAccount", - "params": [ + }, { - "description": "Account id", - "length": 255, - "name": "id", - "related": "enableAccount,listAccounts", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" - } - ] - }, - { - "description": "Adds metric counter for VM auto scaling", - "isasync": true, - "name": "createCounter", - "params": [ + }, { - "description": "Network provider of the counter.", - "length": 255, - "name": "provider", - "required": true, - "since": "4.18.0", + "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": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "Name of the counter.", - "length": 255, - "name": "name", - "required": true, + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "Value of the counter e.g. oid in case of snmp.", - "length": 255, - "name": "value", - "required": true, + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "Source of the counter.", - "length": 255, - "name": "source", - "required": true, + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { @@ -127090,354 +142173,441 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "Source of the counter.", - "name": "source", - "type": "string" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "Provider of the counter.", - "name": "provider", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "Name of the counter.", - "name": "name", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "the id of the Counter", - "name": "id", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, - {} - ] - }, - { - "description": "List Event Types", - "isasync": false, - "name": "listEventTypes", - "params": [], - "related": "", - "response": [ - {}, - {}, { - "description": "Event Type", + "description": "the template name", "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" } ] }, { - "description": "Disables out-of-band management for a cluster", - "isasync": true, - "name": "disableOutOfBandManagementForCluster", + "description": "List VNF appliance owned by the account.", + "isasync": false, + "name": "listVnfAppliances", "params": [ { - "description": "the ID of the cluster", + "description": "the IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, - { - "description": "the operation result description", - "name": "description", - "type": "string" + "name": "ids", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, + "since": "4.4", + "type": "list" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the target hypervisor for the template", + "length": 255, + "name": "hypervisor", + "required": false, "type": "string" }, { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", + "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 out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "description": "the out-of-band management interface username", - "name": "username", + "description": "list vms by ssh keypair name", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", - "type": "string" + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, - {}, { - "description": "the operation result", - "name": "status", + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, "type": "boolean" }, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the security group ID", + "length": 255, + "name": "securitygroupid", + "related": "", + "required": false, + "since": "4.15", + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the out-of-band management interface port", - "name": "port", - "type": "string" + "description": "the group ID", + "length": 255, + "name": "groupid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the out-of-band management interface address", - "name": "address", - "type": "string" + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "length": 255, + "name": "userdata", + "required": false, + "since": "4.18.0.0", + "type": "boolean" }, - {} - ], - "since": "4.9.0" - }, - { - "description": "Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted", - "isasync": false, - "name": "prepareForShutdown", - "params": [ { - "description": "the uuid of the management server", + "description": "list by network id", "length": 255, - "name": "managementserverid", - "related": "", - "required": true, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ - {}, - { - "description": "Indicates whether a shutdown has been triggered", - "name": "shutdowntriggered", - "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "list by the service offering", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "since": "4.4", + "type": "uuid" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list vms by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "The id of the management server", - "name": "managementserverid", - "type": "long" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "Indicates whether CloudStack is ready to shutdown", - "name": "readyforshutdown", + "description": "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.", + "length": 255, + "name": "accumulate", + "required": false, + "since": "4.17.0", "type": "boolean" }, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" - } - ], - "since": "4.19.0" - }, - { - "description": "Adds a new cluster", - "isasync": false, - "name": "addCluster", - "params": [ + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, { - "description": "Ovm3 native OCFS2 clustering enabled for cluster", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "ovm3cluster", + "name": "showicon", "required": false, - "type": "string" + "since": "4.16.0.0", + "type": "boolean" }, { - "description": "the Pod ID for the host", + "description": "flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "isvnf", + "required": false, + "since": "4.19.0", + "type": "boolean" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "list by the backup offering", "length": 255, - "name": "clustertype", - "required": true, - "type": "string" + "name": "backupofferingid", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "Ovm3 native pooling enabled for cluster", + "description": "comma separated list of vm details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.", "length": 255, - "name": "ovm3pool", + "name": "details", "required": false, - "type": "string" + "type": "list" }, { - "description": "the cluster name", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "clustername", - "required": true, - "type": "string" + "name": "userid", + "related": "getUser", + "required": false, + "type": "uuid" }, { - "description": "Ovm3 vip to use for pool (and cluster)", + "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": "ovm3vip", + "name": "state", "required": false, "type": "string" }, { - "description": "the password for the host", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "password", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "the password for the VSM associated with this cluster", + "description": "list vms by iso", "length": 255, - "name": "vsmpassword", + "name": "isoid", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "guestvswitchtype", + "name": "displayvm", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the URL", + "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": "url", + "name": "name", "required": false, "type": "string" }, { - "description": "Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "publicvswitchtype", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the username for the cluster", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "username", + "name": "haenable", "required": false, - "type": "string" + "since": "4.15", + "type": "boolean" }, { - "description": "the ipaddress of the VSM associated with this cluster", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "vsmipaddress", + "name": "autoscalevmgroupid", + "related": "", "required": false, - "type": "string" + "since": "4.18.0", + "type": "uuid" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "allocationstate", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the username for the VSM associated with this cluster", + "description": "list vms by vpc", "length": 255, - "name": "vsmusername", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", + "description": "list vms by template", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": false, + "type": "uuid" }, { - "description": "the Zone ID for the cluster", + "description": "the ID of the virtual machine", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "id", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "required": false, "type": "uuid" }, { - "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "guestvswitchname", + "name": "account", "required": false, "type": "string" }, { - "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", + "description": "List by keyword", "length": 255, - "name": "publicvswitchname", + "name": "keyword", "required": false, "type": "string" } ], - "related": "", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", "response": [ { - "description": "the type of the cluster", - "name": "clustertype", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { @@ -127446,102 +142616,449 @@ "type": "boolean" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the capacity of the Cluster", - "name": "capacity", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the ID of the affinity group", + "name": "id", + "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ], - "type": "list" - }, - {}, - { - "description": "the cluster name", - "name": "name", - "type": "string" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" + "type": "set" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, + {}, { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the cluster ID", - "name": "id", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the 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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "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": "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" + }, + { + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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 ID of the security group", + "name": "id", + "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 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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the 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 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 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" + } + ], + "type": "set" }, { "description": "the current status of the latest async job acting on this object", @@ -127549,194 +143066,241 @@ "type": "integer" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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 value", + "name": "value", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "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": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - } - ] - }, - { - "description": "Deletes an traffic monitor host.", - "isasync": false, - "name": "deleteTrafficMonitor", - "params": [ - { - "description": "Id of the Traffic Monitor Host.", - "length": 255, - "name": "id", - "related": "reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, - {}, - {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" - } - ] - }, - { - "description": "Removes VM from specified network by deleting a NIC", - "isasync": true, - "name": "removeNicFromVirtualMachine", - "params": [ + }, { - "description": "Virtual Machine ID", - "length": 255, - "name": "virtualmachineid", - "related": "destroyVirtualMachine,scaleVirtualMachine,removeNicFromVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", - "required": true, - "type": "uuid" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "NIC ID", - "length": 255, - "name": "nicid", - "related": "", - "required": true, - "type": "uuid" - } - ], - "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", - "response": [ + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, + {}, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -127744,98 +143308,46 @@ "name": "publicipid", "type": "string" }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, {}, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "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 domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - }, - { - "description": "the project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the affinity group", - "name": "id", - "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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - } - ], - "type": "set" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", @@ -127843,49 +143355,44 @@ "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { "description": "the date when this virtual machine was updated last time", @@ -127893,149 +143400,102 @@ "type": "date" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, { "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", "name": "templateid", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "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", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag value", - "name": "value", - "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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { @@ -128044,23 +143504,23 @@ "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 ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -128069,68 +143529,43 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, { "description": "the name of the corresponding network", "name": "networkname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "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": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -128139,23 +143574,18 @@ "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -128164,510 +143594,258 @@ "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" } ], "type": "set" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, { "description": "the VM's disk read in KiB", "name": "diskkbsread", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + } + ], + "since": "4.19.1" + }, + { + "description": "Adds stratosphere ssp server", + "isasync": false, + "name": "addStratosphereSsp", + "params": [ + { + "description": "stratosphere ssp tenant uuid", + "length": 255, + "name": "tenantuuid", + "required": false, "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "stratosphere ssp api password", + "length": 255, + "name": "password", + "required": false, "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "stratosphere ssp server url", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "stratosphere ssp api name", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "stratosphere ssp api username", + "length": 255, + "name": "username", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ + {}, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "url of ssp endpoint", + "name": "url", "type": "string" }, + {}, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "server id of the stratosphere ssp server", + "name": "hostid", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "name", + "name": "name", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "zone which this ssp controls", + "name": "zoneid", "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, + } + ] + }, + { + "description": "Creates a storage pool.", + "isasync": false, + "name": "createStoragePool", + "params": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "length": 255, + "name": "istagarule", + "required": false, + "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the Pod ID for the storage pool", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the details for the storage pool", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { - "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 domain name of the security group", - "name": "domain", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "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 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 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 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 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 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": "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 value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "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 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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the 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 list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - } - ], - "type": "set" + "description": "the name for the storage pool", + "length": 255, + "name": "name", + "required": true, + "type": "string" }, - {}, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the scope of the storage: cluster or zone", + "length": 255, + "name": "scope", + "required": false, "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the URL of the storage pool", + "length": 255, + "name": "url", + "required": true, "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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", + "required": false, "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the Zone ID for the storage pool", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "length": 255, + "name": "capacityiops", + "required": false, + "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the cluster ID for the storage pool", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "type": "uuid" + }, + { + "description": "the storage provider name", + "length": 255, + "name": "provider", + "required": false, "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "bytes CloudStack can provision from this storage pool", + "length": 255, + "name": "capacitybytes", + "required": false, + "type": "long" }, - {}, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "whether the storage should be managed by CloudStack", + "length": 255, + "name": "managed", + "required": false, "type": "boolean" - }, + } + ], + "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", + "response": [ { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { @@ -128676,224 +143854,215 @@ "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" - } - ] - }, - { - "description": "Activates a project", - "isasync": true, - "name": "activateProject", - "params": [ + }, { - "description": "id of the project to be modified", - "length": 255, - "name": "id", - "related": "activateProject", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + {}, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", - "type": "integer" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", - "type": "long" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the name of the project", - "name": "name", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the host's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, + {}, { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + } + ] + }, + { + "description": "Lists storage pools available for migration of a volume.", + "isasync": false, + "name": "findStoragePoolsForMigration", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", - "type": "string" + "description": "the ID of the volume", + "length": 255, + "name": "id", + "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "cancelStorageMaintenance,enableStorageMaintenance", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "whether this pool is managed or not", + "name": "managed", + "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", @@ -128901,550 +144070,538 @@ "type": "integer" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "the id of the project", + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" + }, + { + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + { + "description": "the ID of the storage pool", "name": "id", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, - {}, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the date this project was created", + "description": "the date and time the storage pool was created", "name": "created", "type": "date" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, + {}, + {}, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" } - ], - "since": "3.0.0" + ] }, { - "description": "Delete a certificate to CloudStack", - "isasync": false, - "name": "deleteSslCert", + "description": "delete Tungsten-Fabric firewall rule", + "isasync": true, + "name": "deleteTungstenFabricFirewallRule", "params": [ { - "description": "Id of SSL certificate", + "description": "the uuid of Tungsten-Fabric firewall rule", "length": 255, - "name": "id", - "related": "uploadSslCert", + "name": "firewallruleuuid", + "required": true, + "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, { - "description": "Lists dedicated hosts.", - "isasync": false, - "name": "listDedicatedHosts", + "description": "disable a Cisco Nexus VSM device", + "isasync": true, + "name": "disableCiscoNexusVSM", "params": [ { - "description": "", + "description": "Id of the Cisco Nexus 1000v VSM device to be deleted", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "id", + "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", + "required": true, + "type": "uuid" + } + ], + "related": "listCiscoNexusVSMs", + "response": [ + { + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, + {}, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { - "description": "the ID of the host", - "length": 255, - "name": "hostid", - "related": "reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the account associated with the host. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "the ID of the domain associated with the host", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "device name", + "name": "vsmdevicename", + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list dedicated hosts by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "", - "required": false, - "type": "uuid" - } - ], - "related": "", - "response": [ - { - "description": "the domain ID of the host", - "name": "domainid", + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" - }, - {} + } ] }, { - "description": "upload an existing ISO into the CloudStack cloud.", - "isasync": false, - "name": "getUploadParamsForIso", + "description": "Creates a Storage network IP range.", + "isasync": true, + "name": "createStorageNetworkIpRange", "params": [ { - "description": "Upload volume/template/iso for the project", + "description": "the ending IP address", "length": 255, - "name": "projectid", - "related": "", + "name": "endip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", + "description": "the netmask for storage network", "length": 255, - "name": "checksum", - "required": false, + "name": "netmask", + "required": true, "type": "string" }, { - "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", + "description": "UUID of pod where the ip range belongs to", "length": 255, - "name": "ostypeid", - "related": "", - "required": false, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, "type": "uuid" }, { - "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": "true if you want this ISO to be featured", + "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" - }, - { - "description": "the display text of the ISO. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", + "name": "vlan", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the name of the volume/template/iso", + "description": "the beginning IP address", "length": 255, - "name": "name", + "name": "startip", "required": true, "type": "string" }, { - "description": "the ID of the zone the volume/template/iso is to be hosted on", + "description": "the gateway for storage network", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "gateway", "required": true, - "type": "uuid" - }, - { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" - }, + "type": "string" + } + ], + "related": "", + "response": [ { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "true if the ISO or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" + "description": "the end ip of the storage network IP range", + "name": "endip", + "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the uuid of storage network IP range.", + "name": "id", + "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "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", + "description": "the start ip of the storage network IP range", + "name": "startip", "type": "string" }, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "the network uuid of storage network IP range", + "name": "networkid", + "type": "string" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "the netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, - {}, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the Pod uuid for the storage network IP range", + "name": "podid", "type": "string" } ], - "since": "4.13" + "since": "3.0.0" }, { - "description": "Get diagnostics and files from system VMs", + "description": "Configures an ovs element.", "isasync": true, - "name": "getDiagnosticsData", + "name": "configureOvsElement", "params": [ { - "description": "The ID of the system VM instance to retrieve diagnostics data files from", + "description": "Enabled/Disabled the service provider", "length": 255, - "name": "targetid", - "related": "", + "name": "enabled", "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided.", + "description": "the ID of the ovs provider", "length": 255, - "name": "files", - "required": false, - "type": "list" + "name": "id", + "related": "configureOvsElement", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, - {}, { - "description": "Storage URL to download retrieve diagnostics data files", - "name": "url", + "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" }, - {} - ], - "since": "4.14.0.0" - }, - { - "description": "Deletes a autoscale vm group.", - "isasync": true, - "name": "deleteAutoScaleVmGroup", - "params": [ { - "description": "the ID of the autoscale group", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" }, { - "description": "true if all VMs have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.18.0", - "type": "boolean" - } - ], - "response": [ + "description": "the physical network service provider id of the provider", + "name": "nspid", + "type": "string" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the id of the ovs", + "name": "id", "type": "string" }, + {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "path of the domain to which the provider belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account associated with the provider", + "name": "account", + "type": "string" }, - {} + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + } ] }, { - "description": "lists Palo Alto firewall devices in a physical network", + "description": "Lists System VM stats", "isasync": false, - "name": "listPaloAltoFirewalls", + "name": "listSystemVmsUsageHistory", "params": [ { - "description": "Palo Alto firewall device ID", + "description": "the ID of the system VM.", "length": 255, - "name": "fwdeviceid", - "related": "addPaloAltoFirewall,listPaloAltoFirewalls", + "name": "id", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", "required": false, "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "the IDs of the system VMs, mutually exclusive with id.", "length": 255, - "name": "keyword", + "name": "ids", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", "required": false, - "type": "string" + "type": "list" }, { - "description": "", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "pagesize", + "name": "startdate", "required": false, - "type": "integer" + "type": "date" }, { - "description": "", + "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" - } - ], - "related": "addPaloAltoFirewall", - "response": [ - { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", - "type": "string" + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" - }, + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", - "type": "string" + "description": "the list of VM stats", + "name": "stats", + "type": "list" }, { "description": "the current status of the latest async job acting on this object", @@ -129452,226 +144609,199 @@ "type": "integer" }, { - "description": "device state", - "name": "fwdevicestate", - "type": "string" - }, - { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, + {}, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device name", - "name": "fwdevicename", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {} + ], + "since": "4.18.0" + }, + { + "description": "Deletes a IPv6 firewall rule", + "isasync": true, + "name": "deleteIpv6FirewallRule", + "params": [ { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, + "description": "the ID of the IPv6 firewall rule", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "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": "the zone ID of the external firewall", - "name": "zoneid", + "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 username that's used to log in to the external firewall", - "name": "username", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, { - "description": "Updates load balancer", + "description": "Creates a firewall rule for a given IP address", "isasync": true, - "name": "updateLoadBalancerRule", + "name": "createFirewallRule", "params": [ { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, - "name": "fordisplay", + "name": "protocol", + "required": true, + "type": "string" + }, + { + "description": "type of firewallrule: system/user", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "description": "the starting port of firewall rule", + "length": 255, + "name": "startport", "required": false, - "since": "4.4", - "type": "boolean" + "type": "integer" }, { - "description": "The protocol for the LB", + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "protocol", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "error code for this icmp message", "length": 255, - "name": "algorithm", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "type of the ICMP message being sent", "length": 255, - "name": "customid", + "name": "icmptype", "required": false, - "since": "4.4", - "type": "string" + "type": "integer" }, { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "the ending port of firewall rule", + "length": 255, + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the name of the load balancer rule", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "name", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the ID of the load balancer rule to update", + "description": "the IP address id of the port forwarding rule", "length": 255, - "name": "id", - "related": "", + "name": "ipaddressid", + "related": "associateIpAddress,listPublicIpAddresses", "required": true, "type": "uuid" } ], - "related": "listLoadBalancerRules", + "related": "updateEgressFirewallRule", "response": [ { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "type": "string" - }, - { - "description": "the id of the guest network the lb rule belongs to", + "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 project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", - "type": "string" - }, - { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", + "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": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the list of resource tags associated with load balancer", + "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -129680,1580 +144810,1445 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, - {}, { - "description": "the name of the load balancer", - "name": "name", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the private port", - "name": "privateport", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the ID of the firewall rule", + "name": "id", "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": "the public ip address", - "name": "publicip", + "description": "the traffic type for the firewall rule", + "name": "traffictype", + "type": "string" + }, + { + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" } ] }, { - "description": "Delete one or more alerts.", - "isasync": false, - "name": "deleteAlerts", + "description": "Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.", + "isasync": true, + "name": "createVolume", "params": [ { - "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "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": "startdate", + "name": "virtualmachineid", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "the IDs of the alerts", + "description": "the name of the disk volume", "length": 255, - "name": "ids", - "related": "", + "name": "name", "required": false, - "type": "list" + "type": "string" }, { - "description": "end date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "enddate", + "name": "diskofferingid", + "related": "", "required": false, - "type": "date" + "type": "uuid" }, { - "description": "delete by alert type", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "type", + "name": "customid", "required": false, "type": "string" - } - ], - "response": [ + }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.", + "length": 255, + "name": "snapshotid", + "related": "listSnapshots", + "required": false, + "type": "uuid" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "the project associated with the volume. Mutually exclusive with account parameter", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain ID associated with the disk offering. If used with the account parameter returns the disk volume associated with the account for the specified domain.If account is NOT provided then the volume will be assigned to the caller account and domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "max iops", + "length": 255, + "name": "maxiops", + "required": false, + "type": "long" }, - {}, - {} - ] - }, - { - "description": "Enables an account", - "isasync": false, - "name": "enableAccount", - "params": [ { - "description": "Account id", + "description": "min iops", "length": 255, - "name": "id", - "related": "enableAccount,listAccounts", + "name": "miniops", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "Enables specified account in this domain.", + "description": "Arbitrary volume size", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "size", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "Enables specified account.", + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" + }, + { + "description": "the ID of the availability zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "an optional field, whether to display the volume to the end user or not.", + "length": 255, + "name": "displayvolume", + "required": false, + "type": "boolean" } ], - "related": "listAccounts", + "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, - {}, { - "description": "the ID of the role", - "name": "roleid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "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 network domain", - "name": "networkdomain", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, - {}, { - "description": "the name of the role", - "name": "rolename", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the project name of the vpn", + "name": "project", "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 total volume available for this account", - "name": "volumeavailable", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "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 name", - "name": "username", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "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 ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "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 date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "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": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "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 lastname", - "name": "lastname", - "type": "string" - } - ], - "type": "list" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, + { + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the state of the account", - "name": "state", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the ID of the device on user vm the volume is attahed to. This tag is not returned when the volume is detached.", + "name": "deviceid", + "type": "long" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, + {}, { - "description": "the name of the account", - "name": "name", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the list of resource tags associated", + "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 id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", + "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - } + "description": "the state of the disk volume", + "name": "state", + "type": "string" + }, + {} ] }, { - "description": "Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.", - "isasync": true, - "name": "createAutoScaleVmProfile", + "description": "List virtual machine snapshot by conditions", + "isasync": false, + "name": "listVMSnapshot", "params": [ { - "description": "account that will own the autoscale VM profile", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "domain ID of the account owning a autoscale VM profile", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "", "length": 255, - "name": "autoscaleuserid", - "related": "getUser", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18.1", - "type": "map" - }, - { - "description": "an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST(via POST body), you can send up to 1MB of data after base64 encoding.You also need to change vm.userdata.max.length value", - "length": 1048576, - "name": "userdata", + "name": "account", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "an optional project for the autoscale VM profile", + "description": "", "length": 255, - "name": "projectid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the time allowed for existing connections to get closed before a vm is expunged", + "description": "The ID of the VM snapshot", "length": 255, - "name": "expungevmgraceperiod", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the service offering of the auto deployed virtual machine", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" }, { - "description": "the template of the auto deployed virtual machine", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the ID of the Userdata", + "description": "lists snapshot by snapshot name or display name", "length": 255, - "name": "userdataid", - "related": "", + "name": "name", "required": false, - "since": "4.18.1", - "type": "uuid" + "type": "string" }, { - "description": "an optional field, whether to the display the profile to the end user or not", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "fordisplay", + "name": "listall", "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "availability zone for the auto deployed virtual machine", + "description": "the ID of the vm", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "virtualmachineid", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "required": false, "type": "uuid" }, { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "counterparam", + "name": "tags", "required": false, "type": "map" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".", + "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", "length": 255, - "name": "otherdeployparams", + "name": "vmsnapshotids", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "map" - } - ], - "related": "", - "response": [ - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the account owning the instance group", - "name": "account", - "type": "string" - }, - {}, - { - "description": "the service offering to be used while deploying a virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the project id vm profile", - "name": "projectid", - "type": "string" + "since": "4.9", + "type": "list" }, { - "description": "the project name of the vm profile", - "name": "project", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, - { - "description": "Base 64 encoded VM user data", - "name": "userdata", + "description": "state of the virtual machine snapshot", + "length": 255, + "name": "state", + "required": false, "type": "string" - }, - {}, + } + ], + "related": "createVMSnapshot", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, - {}, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, - {}, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "description": "the domain name of the vm profile", - "name": "domain", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" - } - ] - }, - { - "description": "Register the OAuth2 provider in CloudStack", - "isasync": false, - "name": "registerOauthProvider", - "params": [ + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", + "type": "string" + }, + {}, { - "description": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" }, + {}, { - "description": "Client ID pre-registered in the specific OAuth provider", - "length": 255, - "name": "clientid", - "required": true, + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", "type": "string" }, { - "description": "Name of the provider from the list of OAuth providers supported in CloudStack", - "length": 255, - "name": "provider", - "required": true, + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", - "length": 255, - "name": "redirecturi", - "required": true, + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "Description of the OAuth Provider", - "length": 255, + "description": "the description of the vm snapshot", "name": "description", - "required": true, "type": "string" }, { - "description": "Secret Key pre-registered in the specific OAuth provider", - "length": 255, - "name": "secretkey", - "required": true, + "description": "the parent displayName of the vm snapshot", + "name": "parentName", "type": "string" - } - ], - "response": [ + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, - {} + { + "description": "the parent ID of the vm snapshot", + "name": "parent", + "type": "string" + }, + { + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" + }, + { + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" + } ], - "since": "4.19.0" + "since": "4.2.0" }, { - "description": "Lists load balancer stickiness policies.", - "isasync": false, - "name": "listLBStickinessPolicies", + "description": "Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list", + "isasync": true, + "name": "moveNetworkAclItem", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "fordisplay", + "name": "customid", "required": false, "since": "4.4", - "type": "boolean" - }, - { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the load balancer stickiness policy", + "description": "The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.", "length": 255, - "name": "id", - "related": "listLBStickinessPolicies", + "name": "previousaclruleid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "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": "pagesize", + "name": "nextaclruleid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "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": "keyword", + "name": "aclconsistencyhash", "required": false, "type": "string" }, { - "description": "", + "description": "The ID of the network ACL rule that is being moved to a new position.", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "id", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the LB rule ID", - "name": "lbruleid", - "type": "string" - }, - { - "description": "the account of the Stickiness policy", - "name": "account", - "type": "string" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", + "description": "the list of resource tags associated with the network ACLs", + "name": "tags", "response": [ { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the params of the policy", - "name": "params", - "type": "map" + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "type": "list" }, + {}, { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the state of the policy", - "name": "state", - "type": "string" - }, - { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, - {}, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Adds a Ucs manager", - "isasync": false, - "name": "addUcsManager", - "params": [ - { - "description": "the name of UCS url", - "length": 255, - "name": "url", - "required": true, + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the name of UCS manager", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "the Zone id for the ucs manager", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" }, { - "description": "the username of UCS", - "length": 255, - "name": "username", - "required": true, + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { - "description": "the password of UCS", - "length": 255, - "name": "password", - "required": true, + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the zone ID of ucs manager", - "name": "zoneid", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, - {}, { - "description": "the name of ucs manager", - "name": "name", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the ucs manager", - "name": "id", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the url of ucs manager", - "name": "url", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] }, { - "description": "Deletes a network", + "description": "Disassociates an IP address from the account.", "isasync": true, - "name": "deleteNetwork", + "name": "disassociateIpAddress", "params": [ { - "description": "the ID of the network", + "description": "the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter", "length": 255, "name": "id", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, + "related": "associateIpAddress,listPublicIpAddresses", + "required": false, "type": "uuid" }, { - "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", + "description": "IP Address to be disassociated. Mutually exclusive with the id parameter", "length": 255, - "name": "forced", + "name": "ipaddress", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "string" } ], "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { - "description": "Reconnects a host.", - "isasync": true, - "name": "reconnectHost", + "description": "list baremetal dhcp servers", + "isasync": false, + "name": "listBaremetalDhcp", "params": [ { - "description": "the host ID", + "description": "Type of DHCP device", "length": 255, - "name": "id", - "related": "reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "related": "addBaremetalHost", - "response": [ - { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "name": "dhcpservertype", + "required": false, "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "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 used", - "name": "memoryused", - "type": "long" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", + "description": "DHCP server device ID", + "length": 255, + "name": "id", + "required": false, "type": "long" }, - {}, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", - "name": "suitableformigration", - "type": "boolean" - }, - { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "name of the provider", + "name": "dhcpservertype", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "events available for the host", - "name": "events", + "description": "url", + "name": "url", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of ", + "name": "id", "type": "string" }, + {}, + {} + ] + }, + { + "description": "Puts storage pool into maintenance state", + "isasync": true, + "name": "enableStorageMaintenance", + "params": [ { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" - }, + "description": "Primary storage ID", + "length": 255, + "name": "id", + "related": "cancelStorageMaintenance,enableStorageMaintenance", + "required": true, + "type": "uuid" + } + ], + "related": "cancelStorageMaintenance", + "response": [ { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the ID of the host", - "name": "id", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the cluster name of the host", + "description": "the name of the cluster for the storage pool", "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 last annotation set on this host by an admin", - "name": "annotation", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, + {}, { - "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", + "description": "the hypervisor type of the storage pool", "name": "hypervisor", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the IP address of the host", + "description": "the IP address of the storage pool", "name": "ipaddress", "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the name of the host", - "name": "name", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" - }, - { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" - }, - { - "description": "the state of the host", + "description": "the state of the storage pool", "name": "state", - "type": "status" + "type": "storagepoolstatus" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "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": "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": "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 no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - } - ], - "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the ID of the cluster for the storage pool", + "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": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" } ] }, { - "description": "Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected.", - "isasync": true, - "name": "deleteVnfTemplate", + "description": "Removes an existing secondary storage selector.", + "isasync": false, + "name": "removeSecondaryStorageSelector", "params": [ { - "description": "the ID of the template", + "description": "The unique identifier of the secondary storage selector to be removed.", "length": 255, "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "", "required": true, "type": "uuid" - }, - { - "description": "the ID of zone of the template", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "Force delete a template.", - "length": 255, - "name": "forced", - "required": false, - "since": "4.9+", - "type": "boolean" } ], "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -131264,187 +146259,313 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ], "since": "4.19.0" }, { - "description": "Starts a stopped CloudManaged Kubernetes cluster", - "isasync": true, - "name": "startKubernetesCluster", + "description": "lists all available apis on the server, provided by the Api Discovery plugin", + "isasync": false, + "name": "listApis", "params": [ { - "description": "the ID of the Kubernetes cluster", + "description": "API name", "length": 255, - "name": "id", - "related": "startKubernetesCluster", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "version of CloudStack the api was introduced in", + "name": "since", "type": "string" }, { - "description": "the description of the Kubernetes cluster", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the list params the api accepts", + "name": "params", + "response": [ + { + "description": "true if this parameter is required for the api request", + "name": "required", + "type": "boolean" + }, + { + "description": "description of the api parameter", + "name": "description", + "type": "string" + }, + { + "description": "parameter type", + "name": "type", + "type": "string" + }, + { + "description": "the name of the api parameter", + "name": "name", + "type": "string" + }, + {}, + { + "description": "version of CloudStack the api was introduced in", + "name": "since", + "type": "string" + }, + { + "description": "comma separated related apis to get the parameter", + "name": "related", + "type": "string" + }, + { + "description": "length of the parameter", + "name": "length", + "type": "int" + } + ], + "type": "set" + }, + { + "description": "description of the api", "name": "description", "type": "string" }, {}, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "true if api is asynchronous", + "name": "isasync", + "type": "boolean" + }, + { + "description": "comma separated related apis", + "name": "related", "type": "string" }, + {}, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the api command", + "name": "name", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "response field type", + "name": "type", "type": "string" }, { - "description": "the id of the Kubernetes cluster", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "api response fields", + "name": "response", + "response": [ + { + "description": "response field type", + "name": "type", + "type": "string" + }, + { + "description": "description of the api response field", + "name": "description", + "type": "string" + }, + { + "description": "the name of the api response field", + "name": "name", + "type": "string" + }, + { + "description": "api response fields", + "name": "response", + "type": "set" + } + ], + "type": "set" + } + ], + "since": "4.1.0" + }, + { + "description": "deletes baremetal rack configuration text", + "isasync": true, + "name": "deleteBaremetalRct", + "params": [ + { + "description": "RCT id", + "length": 255, "name": "id", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Creates snapshot for a vm.", + "isasync": true, + "name": "createVMSnapshot", + "params": [ { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" + "description": "quiesce vm if true", + "length": 255, + "name": "quiescevm", + "required": false, + "type": "boolean" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "type": "string" + "description": "The ID of the vm", + "length": 255, + "name": "virtualmachineid", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "required": true, + "type": "uuid" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "snapshot memory if true", + "length": 255, + "name": "snapshotmemory", + "required": false, + "type": "boolean" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "The display name of the snapshot", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The description of the snapshot", + "length": 255, + "name": "description", + "required": false, "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" - }, - { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the parent displayName of the vm snapshot", + "name": "parentName", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", + "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the name of the Kubernetes cluster", + "description": "the name of the vm snapshot", "name": "name", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { - "description": "the state of the Kubernetes cluster", + "description": "the state of the vm snapshot", "name": "state", - "type": "string" + "type": "state" }, + {}, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "VM Snapshot type", + "name": "type", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, + {}, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, { @@ -131453,138 +146574,192 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "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": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "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 size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the description of the vm snapshot", + "name": "description", + "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "indicates if this is current snapshot", + "name": "current", "type": "boolean" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", + "type": "string" + }, + { + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", + "type": "string" } - ] + ], + "since": "4.2.0" }, { - "description": "Deletes a project", + "description": "Deletes an internal load balancer", "isasync": true, - "name": "deleteProject", + "name": "deleteLoadBalancer", "params": [ { - "description": "id of the project to be deleted", + "description": "the ID of the Load Balancer", "length": 255, "name": "id", "related": "", "required": true, "type": "uuid" - }, - { - "description": "true if all project resources have to be cleaned up, false otherwise", - "length": 255, - "name": "cleanup", - "required": false, - "since": "4.16.0", - "type": "boolean" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], - "since": "3.0.0" + "since": "4.2.0" }, { - "description": "lists netscaler load balancer devices", + "description": "Lists Tungsten-Fabric tags", "isasync": false, - "name": "listNetscalerLoadBalancers", + "name": "listTungstenFabricTagType", "params": [ { - "description": "netscaler load balancer device ID", + "description": "the uuid of Tungsten-Fabric tag type", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,listNetscalerLoadBalancers", + "name": "tagtypeuuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the ID of zone", "length": 255, - "name": "keyword", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "addNetscalerLoadBalancer", + "related": "", "response": [ { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "Tungsten-Fabric tag type name", + "name": "name", + "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "Tungsten-Fabric tag type uuid", + "name": "uuid", "type": "string" }, { @@ -131593,327 +146768,238 @@ "type": "integer" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "device state", - "name": "lbdevicestate", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", "type": "long" }, + {} + ] + }, + { + "description": "Returns a download URL for extracting a snapshot. It must be in the Backed Up state.", + "isasync": true, + "name": "extractSnapshot", + "params": [ { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - }, - {}, - { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" - }, - {}, - { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" + "description": "the ID of the zone where the snapshot is located", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "since": "4.20.0", + "type": "uuid" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" - }, + "description": "the ID of the snapshot", + "length": 255, + "name": "id", + "related": "listSnapshots", + "required": true, + "since": "4.20.0", + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.", - "name": "podids", - "type": "list" - }, - { - "description": "device name", - "name": "lbdevicename", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" - } - ] - }, - { - "description": "Creates a vm group", - "isasync": false, - "name": "createInstanceGroup", - "params": [ - { - "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", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "the account of the instance group. The account parameter must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the status of the extraction", + "name": "status", "type": "string" }, - { - "description": "the name of the instance group", - "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, + {}, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, - {}, { - "description": "the name of the instance group", + "description": "the name of the extracted object", "name": "name", "type": "string" }, { - "description": "time and date the instance group was created", + "description": "the time and date the object was created", "name": "created", "type": "date" }, { - "description": "the project ID of the instance group", - "name": "projectid", - "type": "string" - }, - { - "description": "the account owning the instance group", - "name": "account", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded", + "name": "url", "type": "string" }, { - "description": "the ID of the instance group", - "name": "id", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the project name of the instance group", - "name": "project", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "List iso visibility and all accounts that have permissions to view this iso.", + "description": "List registered keypairs", "isasync": false, - "name": "listIsoPermissions", + "name": "listSSHKeyPairs", "params": [ { - "description": "the template ID", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "id", - "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", - "required": true, - "type": "uuid" - } - ], - "related": "listTemplatePermissions,listIsoPermissions", - "response": [ - { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "name": "isrecursive", + "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 domain to which the template belongs", - "name": "domainid", + "description": "A public key fingerprint to look for", + "length": 255, + "name": "fingerprint", + "required": false, "type": "string" }, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, - {}, - {}, { - "description": "the list of projects the template is available for", - "name": "projectids", - "type": "list" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Adds a netscaler load balancer device", - "isasync": true, - "name": "addNetscalerLoadBalancer", - "params": [ - { - "description": "public IP of the site", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "gslbproviderpublicip", + "name": "account", "required": false, "type": "string" }, { - "description": "true if NetScaler device being added is for providing GSLB service", + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", "length": 255, - "name": "gslbprovider", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "URL of the netscaler load balancer appliance.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "url", - "required": true, - "type": "string" + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "private IP of the site", + "description": "the ID of the ssh keypair", "length": 255, - "name": "gslbproviderprivateip", + "name": "id", + "related": "listSSHKeyPairs", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "description": "A key pair name to look for", "length": 255, - "name": "networkdevicetype", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "Credentials to reach netscaler load balancer device", + "description": "List by keyword", "length": 255, - "name": "password", - "required": true, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isexclusivegslbprovider", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" - }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, "type": "uuid" - }, - { - "description": "Credentials to reach netscaler load balancer device", - "length": 255, - "name": "username", - "required": true, - "type": "string" } ], "related": "", "response": [ + {}, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "the domain name of the keypair owner", + "name": "domain", "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": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "the domain id of the keypair owner", + "name": "domainid", + "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", - "type": "boolean" + "description": "the project id of the keypair owner", + "name": "projectid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -131921,485 +147007,266 @@ "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "Name of the keypair", + "name": "name", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, {}, { - "description": "device state", - "name": "lbdevicestate", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" - }, - {}, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", - "type": "string" - }, - { - "description": "device name", - "name": "lbdevicename", - "type": "string" - }, - { - "description": "name of the provider", - "name": "provider", - "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": "Creates an internal load balancer", + "description": "Cancels maintenance for primary storage", "isasync": true, - "name": "createLoadBalancer", + "name": "cancelStorageMaintenance", "params": [ { - "description": "the source port the network traffic will be load balanced from", - "length": 255, - "name": "sourceport", - "required": true, - "type": "integer" - }, - { - "description": "the TCP port of the virtual machine where the network traffic will be load balanced to", - "length": 255, - "name": "instanceport", - "required": true, - "type": "integer" - }, - { - "description": "the network id of the source ip address", + "description": "the primary storage ID", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "id", + "related": "cancelStorageMaintenance", "required": true, "type": "uuid" - }, + } + ], + "related": "", + "response": [ { - "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", - "length": 255, - "name": "algorithm", - "required": true, + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, - { - "description": "the description of the load balancer", - "length": 4096, - "name": "description", - "required": false, + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the load balancer scheme. Supported value in this release is Internal", - "length": 255, - "name": "scheme", - "required": true, + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the source IP address the network traffic will be load balanced from", - "length": 255, - "name": "sourceipaddress", - "required": false, - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "name of the load balancer", - "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the list of rules associated with the Load Balancer", - "name": "loadbalancerrule", - "response": [ - { - "description": "the state of the load balancer rule", - "name": "state", - "type": "string" - }, - { - "description": "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 Load Balancer ID", - "name": "id", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the project name of the Load Balancer", - "name": "project", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "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 name of the instance", - "name": "name", - "type": "string" - }, - { - "description": "the instance ID", - "name": "id", - "type": "string" - } - ], - "type": "list" - }, { "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", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, - {}, { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the name of the Load Balancer", - "name": "name", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the domain ID of the Load Balancer", - "name": "domainid", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the project id of the Load Balancer", - "name": "projectid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, + {}, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the list of resource tags associated with the Load Balancer", - "name": "tags", - "response": [ - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the domain of the Load Balancer", - "name": "domain", - "type": "string" - } - ], - "since": "4.2.0" - }, - { - "description": "Removes network permissions.", - "isasync": false, - "name": "removeNetworkPermissions", - "params": [ - { - "description": "the network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": true, - "type": "uuid" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "accounts", - "required": false, - "type": "list" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "projectids", - "related": "", - "required": false, - "type": "list" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "accountids", - "related": "listAccounts", - "required": false, - "type": "list" - } - ], - "response": [ - {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "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": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, - {} - ], - "since": "4.17.0" - }, - { - "description": "config Tungsten-Fabric service", - "isasync": false, - "name": "configTungstenFabricService", - "params": [ { - "description": "the ID of physical network", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "description": "the storage pool path", + "name": "path", + "type": "string" }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - } - ], - "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" } ] }, { - "description": "list baremetal pxe server", - "isasync": false, - "name": "listBaremetalPxeServers", + "description": "Updates the snapshot policy.", + "isasync": true, + "name": "updateSnapshotPolicy", "params": [ { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "Pxe server device ID", + "description": "the ID of the snapshot policy", "length": 255, "name": "id", + "related": "updateSnapshotPolicy", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "pagesize", + "name": "customid", "required": false, - "type": "integer" + "since": "4.4", + "type": "string" }, { - "description": "List by keyword", + "description": "an optional field, whether to the display the snapshot policy to the end user or not.", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" } ], "related": "", "response": [ + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -132410,513 +147277,474 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "name of the provider", - "name": "provider", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" }, { - "description": "device id of ", - "name": "id", - "type": "string" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" }, { - "description": "url", - "name": "url", + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", "type": "string" }, - {}, - { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ] - }, - { - "description": "Adds a Palo Alto firewall device", - "isasync": true, - "name": "addPaloAltoFirewall", - "params": [ { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "URL of the Palo Alto appliance.", - "length": 255, - "name": "url", - "required": true, - "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": "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": "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "Credentials to reach Palo Alto firewall device", - "length": 255, - "name": "password", - "required": true, + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { - "description": "Credentials to reach Palo Alto firewall device", - "length": 255, - "name": "username", - "required": true, + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, + {}, { - "description": "supports only PaloAltoFirewall", + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + } + ] + }, + { + "description": "Retrieves the current status of asynchronous job.", + "isasync": false, + "name": "queryAsyncJobResult", + "params": [ + { + "description": "the ID of the asynchronous job", "length": 255, - "name": "networkdevicetype", + "name": "jobid", + "related": "queryAsyncJobResult", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the domain id that executed the async command", + "name": "domainid", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "type": "string" + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" }, { - "description": "device state", - "name": "fwdevicestate", - "type": "string" + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", + "type": "long" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the account id that executed the async command", + "name": "accountid", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the result type", + "name": "jobresulttype", "type": "string" }, {}, { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "the private security zone of the external firewall", - "name": "privatezone", + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", - "type": "string" + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", - "type": "string" + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": " the completed date of the job", + "name": "completed", + "type": "date" }, { - "description": "the current status of the latest async job acting on this object", + "description": "the current job status-should be 0 for PENDING", "name": "jobstatus", "type": "integer" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the user that executed the async command", + "name": "userid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the async command executed", + "name": "cmd", "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": "device name", - "name": "fwdevicename", - "type": "string" + "description": " the created date of the job", + "name": "created", + "type": "date" }, - {} + {}, + { + "description": "the account that executed the async command", + "name": "account", + "type": "string" + } ] }, { - "description": "Creates a private gateway", + "description": "Adds a netscaler control center device", "isasync": true, - "name": "createPrivateGateway", + "name": "registerNetscalerControlCenter", "params": [ { - "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 network implementation uri for the private gateway", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" - }, - { - "description": "the VPC network belongs to", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "password", "required": true, - "type": "uuid" - }, - { - "description": "The isolated network this private gateway is associated to.", - "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,updateNetwork,listNetworks", - "required": false, - "since": "4.17.0", - "type": "uuid" + "type": "string" }, { - "description": "the gateway of the Private gateway", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "gateway", + "name": "username", "required": true, "type": "string" }, { - "description": "the uuid of the network offering to use for the private gateways network connection", - "length": 255, - "name": "networkofferingid", - "related": "", - "required": false, - "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 Physical Network ID the network belongs to", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the IP address of the Private gateaway", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "ipaddress", + "name": "numretries", "required": true, - "type": "string" + "type": "integer" }, { - "description": "the netmask of the Private gateway", + "description": "URL of the netscaler controlcenter appliance.", "length": 255, - "name": "netmask", + "name": "ipaddress", "required": true, "type": "string" - }, - { - "description": "the ID of the network ACL", - "length": 255, - "name": "aclid", - "related": "createNetworkACLList", - "required": false, - "type": "uuid" } ], - "related": "createPrivateGateway,listPrivateGateways", + "related": "addNetscalerLoadBalancer", "response": [ { - "description": "the id of the private gateway", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the private gateway", - "name": "projectid", - "type": "string" - }, - { - "description": "zone id of the private gateway", - "name": "zoneid", - "type": "string" - }, - { - "description": "the private gateway's netmask", - "name": "netmask", - "type": "string" - }, - {}, - { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { - "description": "the project name of the private gateway", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", "type": "boolean" }, - { - "description": "ACL name set for private gateway", - "name": "aclname", - "type": "string" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, + {}, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", - "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 gateway", - "name": "gateway", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, - {}, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "type": "string" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", - "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", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" } - ], - "since": "4.17.0" + ] }, { - "description": "Find user account by API key", - "isasync": false, - "name": "getUser", + "description": "Adds metric counter for VM auto scaling", + "isasync": true, + "name": "createCounter", "params": [ { - "description": "API key of the user", + "description": "Name of the counter.", "length": 255, - "name": "userapikey", + "name": "name", "required": true, "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the account ID of the user", - "name": "accountid", + "description": "Source of the counter.", + "length": 255, + "name": "source", + "required": true, "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "Network provider of the counter.", + "length": 255, + "name": "provider", + "required": true, + "since": "4.18.0", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "Value of the counter e.g. oid in case of snmp.", + "length": 255, + "name": "value", + "required": true, "type": "string" - }, - { - "description": "the boolean value representing if the updating target is in caller's child domain", - "name": "iscallerchilddomain", - "type": "boolean" - }, + } + ], + "related": "", + "response": [ { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the user lastname", - "name": "lastname", + "description": "Name of the counter.", + "name": "name", "type": "string" }, + {}, { - "description": "the user state", - "name": "state", + "description": "Provider of the counter.", + "name": "provider", "type": "string" }, + {}, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "Source of the counter.", + "name": "source", + "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "the user ID", + "description": "the id of the Counter", "name": "id", "type": "string" - }, + } + ] + }, + { + "description": "List Event Types", + "isasync": false, + "name": "listEventTypes", + "params": [], + "related": "", + "response": [ { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + {}, { - "description": "the user name", - "name": "username", + "description": "Event Type", + "name": "name", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted", + "isasync": false, + "name": "prepareForShutdown", + "params": [ { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, + "description": "the uuid of the management server", + "length": 255, + "name": "managementserverid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "The id of the management server", + "name": "managementserverid", + "type": "long" }, {}, + {}, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the user firstname", - "name": "firstname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -132925,140 +147753,168 @@ "type": "integer" }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", - "type": "string" + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" }, - {} - ] + { + "description": "The number of jobs in progress", + "name": "pendingjobscount", + "type": "long" + } + ], + "since": "4.19.0" }, { - "description": "Lists load balancer rules.", + "description": "Adds a new cluster", "isasync": false, - "name": "listLoadBalancerRules", + "name": "addCluster", "params": [ { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the Zone ID for the cluster", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "list by network ID the rule belongs to", + "description": "Ovm3 vip to use for pool (and cluster)", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "ovm3vip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", "length": 255, - "name": "tags", + "name": "arch", "required": false, - "type": "map" + "since": "4.20", + "type": "string" }, { - "description": "the name of the load balancer rule", + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "name", + "name": "guestvswitchname", "required": false, "type": "string" }, { - "description": "the ID of the load balancer rule", + "description": "the ipaddress of the VSM associated with this cluster", "length": 255, - "name": "id", - "related": "", + "name": "vsmipaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the cluster name", "length": 255, - "name": "pagesize", + "name": "clustername", + "required": true, + "type": "string" + }, + { + "description": "the password for the host", + "length": 255, + "name": "password", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Ovm3 native pooling enabled for cluster", "length": 255, - "name": "account", + "name": "ovm3pool", "required": false, "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "Ovm3 native OCFS2 clustering enabled for cluster", "length": 255, - "name": "isrecursive", + "name": "ovm3cluster", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "the URL", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "url", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3", "length": 255, - "name": "page", + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "the password for the VSM associated with this cluster", + "length": 255, + "name": "vsmpassword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the availability zone ID", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "clustertype", + "required": true, + "type": "string" + }, + { + "description": "the username for the cluster", + "length": 255, + "name": "username", "required": false, + "type": "string" + }, + { + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, "type": "uuid" }, { - "description": "the public IP address ID of the load balancer rule", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "publicipid", - "related": "associateIpAddress,listPublicIpAddresses", + "name": "allocationstate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the virtual machine of the load balancer rule", + "description": "the username for the VSM associated with this cluster", "length": 255, - "name": "virtualmachineid", - "related": "destroyVirtualMachine,scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", + "name": "vsmusername", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "description": "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": "listall", + "name": "publicvswitchtype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "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": "projectid", - "related": "", + "name": "guestvswitchtype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "keyword", + "name": "publicvswitchname", "required": false, "type": "string" } @@ -133066,345 +147922,676 @@ "related": "", "response": [ { - "description": "the account of the load balancer rule", - "name": "account", - "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 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": "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": "tag key name", - "name": "key", - "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 load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, - {}, { - "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", - "name": "cidrlist", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the id of the zone the rule belongs to", + "description": "the Zone ID of the cluster", "name": "zoneid", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, + {}, { - "description": "the name of the load balancer", - "name": "name", + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the load balancer rule ID", - "name": "id", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the public ip address", - "name": "publicip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" + "description": "the capacity of the Cluster", + "name": "capacity", + "response": [ + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + } + ], + "type": "list" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the cluster name", + "name": "name", "type": "string" }, - {}, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" } ] }, - { - "description": "Deletes a firewall rule", - "isasync": true, - "name": "deleteFirewallRule", + { + "description": "Deletes an traffic monitor host.", + "isasync": false, + "name": "deleteTrafficMonitor", "params": [ { - "description": "the ID of the firewall rule", + "description": "Id of the Traffic Monitor Host.", "length": 255, "name": "id", - "related": "", + "related": "reconnectHost", "required": true, "type": "uuid" } ], "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, { "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" }, - {} + { + "description": "the UUID 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": "Upload a certificate to CloudStack", - "isasync": false, - "name": "uploadSslCert", + "description": "Removes VM from specified network by deleting a NIC", + "isasync": true, + "name": "removeNicFromVirtualMachine", "params": [ { - "description": "SSL certificate", - "length": 16384, - "name": "certificate", + "description": "Virtual Machine ID", + "length": 255, + "name": "virtualmachineid", + "related": "scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Password for the private key", + "description": "NIC ID", "length": 255, - "name": "password", - "required": false, - "type": "string" + "name": "nicid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "response": [ + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "account that will own the SSL certificate", - "length": 255, - "name": "account", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Name for the uploaded certificate", - "length": 255, - "name": "name", - "required": true, + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "Enables revocation checking for certificates", - "length": 255, - "name": "enabledrevocationcheck", - "required": false, - "since": "4.15", - "type": "boolean" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "domain ID of the account owning the SSL certificate", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", + "type": "string" }, { - "description": "an optional project for the SSL certificate", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "Certificate chain of trust", - "length": 2097152, - "name": "certchain", - "required": false, + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "Private key", - "length": 16384, - "name": "privatekey", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "account for the certificate", - "name": "account", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, - {}, { - "description": "certificate chain", - "name": "certchain", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "certificate", - "name": "certificate", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "List of loabalancers this certificate is bound to", - "name": "loadbalancerrulelist", - "type": "list" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, + {}, { - "description": "SSL certificate ID", - "name": "id", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the domain name of the network owner", - "name": "domain", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, - {}, { - "description": "the project name of the certificate", - "name": "project", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "name", - "name": "name", - "type": "string" + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "the 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 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 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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the 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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "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" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "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" + } + ], + "type": "set" }, { "description": "the current status of the latest async job acting on this object", @@ -133412,616 +148599,688 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ] - }, - { - "description": "Updates the registered OAuth provider details", - "isasync": false, - "name": "updateOauthProvider", - "params": [ - { - "description": "Secret Key pre-registered in the specific OAuth provider", - "length": 255, - "name": "secretkey", - "required": false, - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", - "length": 255, - "name": "redirecturi", - "required": false, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "id of the OAuth provider to be updated", - "length": 255, - "name": "id", - "related": "updateOauthProvider", - "required": true, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "OAuth provider will be enabled or disabled based on this value", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "Description of the OAuth Provider", - "length": 255, - "name": "description", - "required": false, + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "Client ID pre-registered in the specific OAuth provider", - "length": 255, - "name": "clientid", - "required": false, + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "ID of the provider", - "name": "id", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, + {}, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "Name of the provider", - "name": "name", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, - {}, { - "description": "Description of the provider registered", - "name": "description", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "Name of the provider", - "name": "provider", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Creates site to site vpn customer gateway", - "isasync": true, - "name": "createVpnCustomerGateway", - "params": [ + }, { - "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", - "length": 255, - "name": "ipsecpsk", - "required": true, + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", - "length": 255, - "name": "ikelifetime", - "required": false, + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", - "length": 255, - "name": "esplifetime", - "required": false, + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "If DPD is enabled for VPN connection", - "length": 255, - "name": "dpd", - "required": false, - "type": "boolean" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "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", + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "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": "resource type", + "name": "resourcetype", + "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 id the tag belongs to", + "name": "projectid", + "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": "IKE policy of the customer gateway", - "length": 255, - "name": "ikepolicy", - "required": true, + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "create site-to-site VPN customer gateway for the project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "since": "4.6", - "type": "uuid" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": true, + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "name of this customer gateway", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "Force Encapsulation for NAT traversal", - "length": 255, - "name": "forceencap", - "required": false, - "type": "boolean" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "ESP policy of the customer gateway", - "length": 255, - "name": "esppolicy", - "required": true, + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "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" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "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": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "public ip address id of the customer gateway", - "length": 255, - "name": "gateway", - "required": true, + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the project name", - "name": "project", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "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 domain name of the owner", - "name": "domain", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the 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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Id of the 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 type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", + "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + } + ], + "type": "set" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, - {}, - {}, - { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" - }, - { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", - "type": "string" - }, { - "description": "name of the customer gateway", - "name": "name", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" - } - ] - }, - { - "description": "Creates a Management network IP range.", - "isasync": true, - "name": "createManagementNetworkIpRange", - "params": [ - { - "description": "The gateway for the management network.", - "length": 255, - "name": "gateway", - "required": true, - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "The netmask for the management network.", - "length": 255, - "name": "netmask", - "required": true, + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "Specify if range is dedicated for CPVM and SSVM.", - "length": 255, - "name": "forsystemvms", - "required": false, + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "The ending IP address.", - "length": 255, - "name": "endip", - "required": false, - "type": "string" - }, - { - "description": "The starting IP address.", - "length": 255, - "name": "startip", - "required": true, - "type": "string" - }, - { - "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", - "length": 255, - "name": "vlan", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "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", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the Pod", - "name": "name", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the capacity of the Pod", - "name": "capacity", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the ID of the affinity group", + "name": "id", + "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the description of the affinity group", + "name": "description", + "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" } ], - "type": "list" + "type": "set" }, { - "description": "the Zone name of the Pod", - "name": "zonename", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, - {}, - { - "description": "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.", - "name": "forsystemvms", - "type": "list" - }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the gateway of the Pod", - "name": "gateway", + "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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, {}, { - "description": "the Zone ID of the Pod", - "name": "zoneid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - } - ], - "type": "list" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "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 Pod", - "name": "id", + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" } - ], - "since": "4.11.0.0" + ] }, { - "description": "Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster", + "description": "Lists dedicated hosts.", "isasync": false, - "name": "listCiscoNexusVSMs", + "name": "listDedicatedHosts", "params": [ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the name of the account associated with the host. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "the ID of the domain associated with the host", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "description": "list dedicated hosts by affinity group", "length": 255, - "name": "clusterid", + "name": "affinitygroupid", "related": "", "required": false, "type": "uuid" @@ -134029,45 +149288,51 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of the host", "length": 255, - "name": "keyword", + "name": "hostid", + "related": "reconnectHost", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "the domain ID of the host", + "name": "domainid", + "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", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" + "description": "the ID of the host", + "name": "hostid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -134075,128 +149340,226 @@ "type": "integer" }, { - "description": "device state", - "name": "vsmdevicestate", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, + {} + ] + }, + { + "description": "upload an existing ISO into the CloudStack cloud.", + "isasync": false, + "name": "getUploadParamsForIso", + "params": [ { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", - "type": "string" + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, - {}, { - "description": "device name", - "name": "vsmdevicename", - "type": "string" + "description": "Upload volume/template/iso for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", + "required": true, + "type": "string" }, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "true if the ISO or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", - "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 mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" - } - ] - }, - { - "description": "Adds vpn users", - "isasync": true, - "name": "addVpnUser", - "params": [ + }, { - "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", + "description": "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "ostypeid", + "related": "", "required": false, "type": "uuid" }, { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "true if you want this ISO to be featured", "length": 255, - "name": "account", + "name": "isfeatured", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "password for the username", + "description": "the name of the volume/template/iso", "length": 255, - "name": "password", + "name": "name", "required": true, "type": "string" }, { - "description": "add vpn user to the specific project", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "projectid", - "related": "", + "name": "bootable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "username for the vpn user", + "description": "the checksum value of this volume/template/iso The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to\n use another algorithm the hexadecimal string is to be prefixed with a string of the form,\n \"{}\", not including the double quotes. In this is the exact string\n representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not\n contain an algorithm called SHA256 or one called sha-256, only SHA-256.", "length": 255, - "name": "username", - "required": true, + "name": "checksum", + "required": false, "type": "string" + }, + { + "description": "the ID of the zone the volume/template/iso is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the template/volume ID", + "name": "id", + "type": "uuid" + }, + { + "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", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, {}, + {}, { - "description": "the username of the vpn user", - "name": "username", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" + }, + { + "description": "signature to be sent in the POST request.", + "name": "signature", "type": "string" + } + ], + "since": "4.13" + }, + { + "description": "Get diagnostics and files from system VMs", + "isasync": true, + "name": "getDiagnosticsData", + "params": [ + { + "description": "The ID of the system VM instance to retrieve diagnostics data files from", + "length": 255, + "name": "targetid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided.", + "length": 255, + "name": "files", + "required": false, + "type": "list" + } + ], + "related": "", + "response": [ + { + "description": "the current status of the latest 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": "Storage URL to download retrieve diagnostics data files", + "name": "url", "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.14.0.0" + }, + { + "description": "Deletes a autoscale vm group.", + "isasync": true, + "name": "deleteAutoScaleVmGroup", + "params": [ + { + "description": "the ID of the autoscale group", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "true if all VMs have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.18.0", + "type": "boolean" + } + ], + "response": [ + {}, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -134205,575 +149568,889 @@ "type": "integer" }, { - "description": "the vpn userID", - "name": "id", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { - "description": "remove an annotation.", + "description": "lists Palo Alto firewall devices in a physical network", "isasync": false, - "name": "removeAnnotation", + "name": "listPaloAltoFirewalls", "params": [ { - "description": "the id of the annotation", + "description": "Palo Alto firewall device ID", "length": 255, - "name": "id", - "required": true, + "name": "fwdeviceid", + "related": "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", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", + "type": "string" }, - {}, { - "description": "The (uu)id of the user that entered the annotation", - "name": "userid", + "description": "the username that's used to log in to the external firewall", + "name": "username", "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 type of the annotated entity", - "name": "entitytype", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, + {}, { - "description": "True if the annotation is available for admins only", - "name": "adminsonly", - "type": "boolean" + "description": "device name", + "name": "fwdevicename", + "type": "string" }, { - "description": "the creation timestamp for this annotation", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the usage interface of the external firewall", + "name": "usageinterface", + "type": "string" + }, + {}, + { + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "description": "the private interface of the external firewall", + "name": "privateinterface", + "type": "string" + }, + { + "description": "the public security zone of the external firewall", + "name": "publiczone", + "type": "string" + }, + { + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", + "type": "string" + }, + { + "description": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" } - ], - "since": "4.11" + ] }, { - "description": "add a baremetal host", - "isasync": false, - "name": "addBaremetalHost", + "description": "Updates load balancer", + "isasync": true, + "name": "updateLoadBalancerRule", "params": [ { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "username", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", - "length": 255, - "name": "password", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" }, { - "description": "the Zone ID for the host", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "the host URL", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "the cluster ID for the host", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "clusterid", - "related": "", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "the Pod ID for the host", + "description": "the ID of the load balancer rule to update", "length": 255, - "name": "podid", + "name": "id", "related": "", "required": true, "type": "uuid" }, { - "description": "hypervisor type of the host", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "hypervisor", - "required": true, + "name": "algorithm", + "required": false, "type": "string" }, { - "description": "ip address intentionally allocated to this host after provisioning", + "description": "the name of the load balancer rule", "length": 255, - "name": "ipaddress", + "name": "name", "required": false, "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "The protocol for the LB", "length": 255, - "name": "hosttags", + "name": "protocol", "required": false, - "type": "list" + "type": "string" + } + ], + "related": "listLoadBalancerRules", + "response": [ + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" }, { - "description": "the cluster name for the host", - "length": 255, - "name": "clustername", - "required": false, + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "Allocation state of this Host for allocation of new resources", - "length": 255, - "name": "allocationstate", - "required": false, + "description": "the private port", + "name": "privateport", "type": "string" - } - ], - "related": "", - "response": [ + }, { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, + {}, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" }, - {}, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the name of the load balancer", + "name": "name", + "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", + "type": "string" }, { - "description": "GPU cards present in the host", - "name": "gpugroup", + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "the public ip address", + "name": "publicip", + "type": "string" + }, + { + "description": "the list of resource tags associated with load balancer", + "name": "tags", "response": [ { - "description": "GPU cards present in the host", - "name": "gpugroupname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the list of enabled vGPUs", - "name": "vgpu", - "response": [ - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", - "type": "long" - }, - { - "description": "Video RAM for this vGPU type", - "name": "videoram", - "type": "long" - }, - { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", - "type": "long" - }, - { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", - "type": "long" - }, - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum displays per user", - "name": "maxheads", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", - "type": "long" - } - ], - "type": "list" + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "list" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "type": "string" + }, + { + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", + "type": "string" + } + ] + }, + { + "description": "Enables an account", + "isasync": false, + "name": "enableAccount", + "params": [ + { + "description": "Enables specified account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Account id", + "length": 255, + "name": "id", + "related": "enableAccount,listAccounts", + "required": false, + "type": "uuid" + }, + { + "description": "Enables specified account.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "listAccounts", + "response": [ + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", + "description": "the date when this account was created", + "name": "created", "type": "date" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "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 user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "type": "string" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "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 domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "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 total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the state of the account", + "name": "state", "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 total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "true if account is default, false otherwise", + "name": "isdefault", "type": "boolean" }, - {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "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 name of the account", + "name": "name", + "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, + {}, { - "description": "the ID of the host", - "name": "id", + "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 host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" } ] }, { - "description": "Deletes a project role permission in the project", - "isasync": false, - "name": "deleteProjectRolePermission", + "description": "Changes the scope of a storage pool when the pool is in Disabled state.This feature is officially tested and supported for Hypervisors: KVM and VMware, Protocols: NFS and Ceph, and Storage Provider: DefaultPrimary. There might be extra steps involved to make this work for other hypervisors and storage options.", + "isasync": true, + "name": "changeStoragePoolScope", "params": [ { - "description": "ID of the project role permission to be deleted", + "description": "the Id of the cluster to use if scope is being set to Cluster", "length": 255, - "name": "id", + "name": "clusterid", "related": "", - "required": true, + "required": false, "type": "uuid" }, { - "description": "ID of the project where the project role permission is to be deleted", + "description": "the scope of the storage: cluster or zone", "length": 255, - "name": "projectid", + "name": "scope", + "required": true, + "type": "string" + }, + { + "description": "the Id of the storage pool", + "length": 255, + "name": "id", "related": "", "required": true, "type": "uuid" @@ -134781,16 +150458,7 @@ ], "response": [ {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -134801,36 +150469,41 @@ "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.15.0" + "since": "4.19.1" }, { - "description": "Deletes a role permission", - "isasync": false, - "name": "deleteRolePermission", + "description": "Deletes a network", + "isasync": true, + "name": "deleteNetwork", "params": [ { - "description": "ID of the role permission", + "description": "the ID of the network", "length": 255, "name": "id", - "related": "", + "related": "createNetwork,updateNetwork,listNetworks", "required": true, "type": "uuid" + }, + { + "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], "response": [ - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -134841,702 +150514,696 @@ "description": "any text associated with the success or failure", "name": "displaytext", "type": "string" - } - ], - "since": "4.9.0" - }, - { - "description": "Updates the quarantine end date for the given public IP address.", - "isasync": false, - "name": "updateQuarantinedIp", - "params": [ + }, + {}, { - "description": "The date when the quarantine will no longer be active.", - "length": 255, - "name": "enddate", - "required": true, - "type": "date" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - }, + } + ] + }, + { + "description": "Reconnects a host.", + "isasync": true, + "name": "reconnectHost", + "params": [ { - "description": "The ID of the public IP address in active quarantine.", + "description": "the host ID", "length": 255, "name": "id", - "related": "updateQuarantinedIp", - "required": false, + "related": "reconnectHost", + "required": true, "type": "uuid" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, - {}, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "End date for the quarantine.", - "name": "enddate", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the date and time the host was created", + "name": "created", "type": "date" }, { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "ID of the quarantine process.", - "name": "id", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "When the quarantine was removed.", - "name": "removed", - "type": "date" + "description": "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise", + "name": "suitableformigration", + "type": "boolean" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "the name of the host", + "name": "name", "type": "string" - } - ], - "since": "4.19" - }, - { - "description": "Update VM Schedule.", - "isasync": false, - "name": "updateVMSchedule", - "params": [ + }, { - "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "description": "GPU cards present in the host", + "name": "gpugroup", + "response": [ + { + "description": "GPU cards present in the host", + "name": "gpugroupname", + "type": "string" + }, + { + "description": "the list of enabled vGPUs", + "name": "vgpu", + "response": [ + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", + "type": "long" + }, + { + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", + "type": "long" + }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, + { + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Video RAM for this vGPU type", + "name": "videoram", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "Name of the schedule", - "length": 255, - "name": "description", - "required": false, + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "Enable VM schedule", - "length": 255, - "name": "enabled", - "required": false, - "type": "boolean" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "ID of VM schedule", - "length": 255, + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + { + "description": "the ID of the host", "name": "id", - "related": "updateVMSchedule", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'", - "length": 255, - "name": "schedule", - "required": false, + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, + "description": "the date and time the host was last pinged", + "name": "lastpinged", "type": "date" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", - "length": 255, - "name": "timezone", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "Date from which the schedule is active", - "name": "startdate", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "Action", - "name": "action", - "type": "action" + "description": "the amount of the host's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "the ID of VM schedule", - "name": "id", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "VM schedule is enabled", - "name": "enabled", + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Description of VM schedule", - "name": "description", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, - {}, { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "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 cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", + "type": "string" }, {}, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" - } - ], - "since": "4.19.0" - }, - { - "description": "Updates a template to VNF template or attributes of a VNF template.", - "isasync": false, - "name": "updateVnfTemplate", - "params": [ + }, { - "description": "the ID of the OS type that best represents the OS of this image.", - "length": 255, - "name": "ostypeid", - "related": "", - "required": false, - "type": "uuid" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "sort key of the template, integer", - "length": 255, - "name": "sortkey", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", - "length": 255, - "name": "cleanupvnfdetails", - "required": false, - "type": "boolean" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", - "length": 255, - "name": "bootable", - "required": false, + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "true if the image supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", - "length": 255, - "name": "vnfdetails", - "required": false, - "type": "map" + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)", - "length": 255, - "name": "cleanupdetails", - "required": false, - "type": "boolean" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the ID of the image file", - "length": 255, - "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "description": "events available for the host", + "name": "events", + "type": "string" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", - "length": 255, - "name": "requireshvm", - "required": false, - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", - "length": 255, - "name": "isrouting", - "required": false, + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", - "length": 255, - "name": "vnfnics", - "required": false, - "type": "map" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the format for the image", - "length": 255, - "name": "format", - "required": false, + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", - "length": 255, - "name": "cleanupvnfnics", - "required": false, - "type": "boolean" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "the name of the image file", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", - "length": 255, - "name": "templatetype", - "required": false, + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" - } - ], - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", - "response": [ - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, {}, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "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 physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the host version", + "name": "version", + "type": "string" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" + } + ] + }, + { + "description": "Starts a stopped CloudManaged Kubernetes cluster", + "isasync": true, + "name": "startKubernetesCluster", + "params": [ + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "startKubernetesCluster", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, + {}, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, + {}, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "description": "the template name", - "name": "name", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "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", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "keypair details", + "name": "keypair", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" }, { - "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "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 control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" - }, + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + } + ] + }, + { + "description": "Deletes a project", + "isasync": true, + "name": "deleteProject", + "params": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "id of the project to be deleted", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "true if all project resources have to be cleaned up, false otherwise", + "length": 255, + "name": "cleanup", + "required": false, + "since": "4.16.0", + "type": "boolean" + } + ], + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", - "name": "userdataparams", + "description": "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.19.0" + "since": "3.0.0" }, { - "description": "Lists all configuration groups (primarily used for UI).", + "description": "Lists all available shared filesystem providers.", "isasync": false, - "name": "listConfigurationGroups", + "name": "listSharedFileSystemProviders", "params": [ { - "description": "lists configuration group by group name", + "description": "List by keyword", "length": 255, - "name": "group", + "name": "keyword", "required": false, "type": "string" }, @@ -135553,46 +151220,18 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ + {}, { - "description": "the precedence of the configuration group", - "name": "precedence", - "type": "long" - }, - { - "description": "the subgroups of the configuration group", - "name": "subgroup", - "response": [ - { - "description": "the precedence of the configuration subgroup", - "name": "precedence", - "type": "long" - }, - { - "description": "the name of the configuration subgroup", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the description of the configuration 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 configuration group", + "description": "the name of the shared filesystem provider", "name": "name", "type": "string" }, @@ -135601,214 +151240,166 @@ "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ], - "since": "4.18.0" + "since": "4.20.0" }, { - "description": "Releases a Pod IP back to the Pod", + "description": "List iso visibility and all accounts that have permissions to view this iso.", "isasync": false, - "name": "releasePodIpAddress", + "name": "listIsoPermissions", "params": [ { - "description": "UUID of the Pod IP", + "description": "the template ID", "length": 255, "name": "id", + "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "required": true, - "type": "long" + "type": "uuid" } ], + "related": "listTemplatePermissions,listIsoPermissions", "response": [ {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the list of projects the template is available for", + "name": "projectids", + "type": "list" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the list of accounts the template is available for", + "name": "account", + "type": "list" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + {} ] }, { - "description": "Updates VPC offering", + "description": "Adds a netscaler load balancer device", "isasync": true, - "name": "updateVPCOffering", + "name": "addNetscalerLoadBalancer", "params": [ { - "description": "the id of the VPC offering", + "description": "public IP of the site", "length": 255, - "name": "id", - "related": "updateVPCOffering", + "name": "gslbproviderpublicip", + "required": false, + "type": "string" + }, + { + "description": "URL of the netscaler load balancer appliance.", + "length": 255, + "name": "url", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "sort key of the VPC offering, integer", + "description": "true if NetScaler device being added is for providing GSLB service", "length": 255, - "name": "sortkey", + "name": "gslbprovider", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the name of the VPC offering", + "description": "private IP of the site", "length": 255, - "name": "name", + "name": "gslbproviderprivateip", "required": false, "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "the Physical Network ID", "length": 255, - "name": "zoneid", - "required": false, - "since": "4.13", - "type": "string" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "description": "true if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB", "length": 255, - "name": "state", + "name": "isexclusivegslbprovider", "required": false, + "type": "boolean" + }, + { + "description": "Credentials to reach netscaler load balancer device", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { - "description": "the display text of the VPC offering", + "description": "Credentials to reach netscaler load balancer device", "length": 255, - "name": "displaytext", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", - "required": false, + "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "length": 255, + "name": "networkdevicetype", + "required": true, "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", - "type": "string" + "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", + "name": "isexclusivegslbprovider", + "type": "boolean" }, { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the name of the vpc offering", - "name": "name", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "description": "the capability name", - "name": "name", - "type": "string" - }, - { - "description": "the capability value", - "name": "value", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { "description": "the current status of the latest async job acting on this object", @@ -135816,267 +151407,145 @@ "type": "integer" }, { - "description": "the id of the vpc offering", - "name": "id", + "description": "device name", + "name": "lbdevicename", "type": "string" }, - {}, { - "description": " indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", + "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": "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 domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "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", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, + {}, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", "type": "boolean" }, + {}, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the management IP address of the external load balancer", + "name": "ipaddress", + "type": "string" } ] }, { - "description": "Updates remote access vpn", - "isasync": true, - "name": "updateRemoteAccessVpn", + "description": "Removes network permissions.", + "isasync": false, + "name": "removeNetworkPermissions", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "customid", + "name": "accounts", "required": false, - "since": "4.4", - "type": "string" + "type": "list" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "the network ID", "length": 255, - "name": "fordisplay", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accountids", + "related": "listAccounts", "required": false, - "since": "4.4", - "type": "boolean" + "type": "list" }, { - "description": "id of the remote access vpn", + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "id", - "related": "updateRemoteAccessVpn", - "required": true, - "type": "uuid" + "name": "projectids", + "related": "", + "required": false, + "type": "list" } ], - "related": "", "response": [ - { - "description": "the range of ips to allocate to the clients", - "name": "iprange", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "the ipsec preshared key", - "name": "presharedkey", - "type": "string" - }, - { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, {}, - { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" - }, - { - "description": "the public ip address of the vpn server", - "name": "publicipid", - "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" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" - }, - { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ], - "since": "4.4" - }, - { - "description": "Lists user two factor authenticator providers", - "isasync": false, - "name": "listUserTwoFactorAuthenticatorProviders", - "params": [ - { - "description": "List user two factor authenticator provider by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the description of the user two factor authenticator provider", - "name": "description", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the user two factor authenticator provider name", - "name": "name", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], - "since": "4.18.0" + "since": "4.17.0" }, { - "description": "Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", - "isasync": true, - "name": "scaleVirtualMachine", + "description": "config Tungsten-Fabric service", + "isasync": false, + "name": "configTungstenFabricService", "params": [ { - "description": "New maximum number of IOPS for the custom disk offering", - "length": 255, - "name": "maxiops", - "required": false, - "since": "4.17", - "type": "long" - }, - { - "description": "New minimum number of IOPS for the custom disk offering", - "length": 255, - "name": "miniops", - "required": false, - "since": "4.17", - "type": "long" - }, - { - "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", - "length": 255, - "name": "automigrate", - "required": false, - "since": "4.17", - "type": "boolean" - }, - { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "The ID of the virtual machine", + "description": "the ID of physical network", "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,deployVnfAppliance,importVm", + "name": "physicalnetworkid", + "related": "", "required": true, "type": "uuid" }, { - "description": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "since": "4.17", - "type": "boolean" - }, - { - "description": "the ID of the service offering for the virtual machine", + "description": "the ID of zone", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "zoneid", + "related": "listZones", "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", @@ -136088,6 +151557,11 @@ "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", @@ -136097,1263 +151571,803 @@ ] }, { - "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", - "isasync": true, - "name": "destroyVirtualMachine", + "description": "list baremetal pxe server", + "isasync": false, + "name": "listBaremetalPxeServers", "params": [ { - "description": "Comma separated list of UUIDs for volumes that will be deleted", + "description": "List by keyword", "length": 255, - "name": "volumeids", - "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "keyword", "required": false, - "since": "4.12.0", - "type": "list" + "type": "string" }, { - "description": "If true is passed, the vm is expunged immediately. False by default.", + "description": "", "length": 255, - "name": "expunge", + "name": "pagesize", "required": false, - "since": "4.2.1", - "type": "boolean" + "type": "integer" }, { - "description": "The ID of the virtual machine", + "description": "Pxe server device ID", "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,deployVnfAppliance,importVm", - "required": true, - "type": "uuid" - } - ], - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", - "response": [ - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "required": false, "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - {}, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" - }, - { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, + } + ], + "related": "", + "response": [ { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "device id of ", + "name": "id", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the physical network to which this external dhcp device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "url", + "name": "url", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, + {} + ] + }, + { + "description": "Find user account by API key", + "isasync": false, + "name": "getUser", + "params": [ { - "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": "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 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 ID of the affinity group", - "name": "id", - "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 description of the affinity group", - "name": "description", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "API key of the user", + "length": 255, + "name": "userapikey", + "required": true, "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, + {}, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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 domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, + {}, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the user firstname", + "name": "firstname", "type": "string" - }, + } + ] + }, + { + "description": "Lists load balancer rules.", + "isasync": false, + "name": "listLoadBalancerRules", + "params": [ { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "list by network ID the rule belongs to", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": false, + "type": "uuid" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the availability zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the ID of the virtual machine of the load balancer rule", + "length": 255, + "name": "virtualmachineid", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "required": false, + "type": "uuid" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", - "response": [ - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the 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 value", - "name": "value", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "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 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the group", - "name": "project", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "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" - } - ], - "type": "set" + "description": "the public IP address ID of the load balancer rule", + "length": 255, + "name": "publicipid", + "related": "associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the name of the load balancer rule", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + } + ], + "related": "", + "response": [ { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the state of the rule", + "name": "state", "type": "string" }, - {}, - {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the name of the load balancer", + "name": "name", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated with load balancer", + "name": "tags", "response": [ { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "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 NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "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 ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "tag value", + "name": "value", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the private port", + "name": "privateport", "type": "string" }, + {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the public ip address id", + "name": "publicipid", "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" } ] }, { - "description": "Updates egress firewall rule ", + "description": "Creates a Management network IP range.", "isasync": true, - "name": "updateEgressFirewallRule", + "name": "createManagementNetworkIpRange", "params": [ { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "The netmask for the management network.", "length": 255, - "name": "fordisplay", + "name": "netmask", + "required": true, + "type": "string" + }, + { + "description": "The ending IP address.", + "length": 255, + "name": "endip", "required": false, - "since": "4.4", + "type": "string" + }, + { + "description": "UUID of POD, where the IP range belongs to.", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, + { + "description": "Specify if range is dedicated for CPVM and SSVM.", + "length": 255, + "name": "forsystemvms", + "required": false, + "type": "boolean" + }, + { + "description": "The starting IP address.", + "length": 255, + "name": "startip", + "required": true, + "type": "string" + }, + { + "description": "Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan", + "length": 255, + "name": "vlan", + "required": false, + "type": "string" + }, + { + "description": "The gateway for the management network.", + "length": 255, + "name": "gateway", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "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 Zone name of the Pod", + "name": "zonename", + "type": "string" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "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 starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" + }, { - "description": "the ID of the egress firewall rule", - "length": 255, + "description": "the ID of the Pod", "name": "id", - "related": "", - "required": true, - "type": "uuid" + "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", - "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" - } - ], - "related": "", - "response": [ + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { - "description": "the ID of the firewall rule", - "name": "id", + "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 gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the 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": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "resource type", - "name": "resourcetype", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the capacity name", + "name": "name", "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", - "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 traffic type for the firewall rule", - "name": "traffictype", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting port of firewall rule's port range", - "name": "startport", - "type": "integer" - }, - { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the gateway of the Pod", + "name": "gateway", "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 Zone ID of the Pod", + "name": "zoneid", "type": "string" }, { - "description": "the network id of the firewall rule", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, {} ], - "since": "4.4" + "since": "4.11.0.0" }, { - "description": "Lists all supported OS categories for this cloud.", + "description": "Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster", "isasync": false, - "name": "listOsCategories", + "name": "listCiscoNexusVSMs", "params": [ { - "description": "List by keyword", + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "keyword", + "name": "clusterid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -137363,957 +152377,911 @@ "type": "integer" }, { - "description": "list Os category by id", + "description": "", "length": 255, - "name": "id", - "related": "listOsCategories", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list os category by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, - "since": "3.0.1", "type": "string" } ], "related": "", "response": [ { - "description": "the ID of the OS category", - "name": "id", - "type": "string" + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" }, {}, { - "description": "the name of the OS category", - "name": "name", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" - } - ] - }, - { - "description": "Lists all available service offerings.", - "isasync": false, - "name": "listServiceOfferings", - "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" }, { - "description": "the RAM memory that listed offering must support", - "length": 255, - "name": "memory", - "required": false, - "since": "4.15", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", + "type": "string" }, { - "description": "the CPU number that listed offerings must support", - "length": 255, - "name": "cpunumber", - "required": false, - "since": "4.15", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", "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.", - "length": 255, - "name": "virtualmachineid", - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,importVm", - "required": false, - "type": "uuid" - }, - { - "description": "id of zone disk offering is associated with", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "since": "4.13", - "type": "uuid" - }, - { - "description": "the storage type of the service offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, - "since": "4.19", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, { - "description": "ID of the service offering", - "length": 255, - "name": "id", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, + {}, { - "description": "the CPU speed that listed offerings must support", - "length": 255, - "name": "cpuspeed", - "required": false, - "since": "4.15", - "type": "integer" + "description": "device name", + "name": "vsmdevicename", + "type": "string" }, { - "description": "listed offerings support root disk encryption", - "length": 255, - "name": "encryptroot", - "required": false, - "since": "4.18", - "type": "boolean" + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" + } + ] + }, + { + "description": "Adds vpn users", + "isasync": true, + "name": "addVpnUser", + "params": [ { - "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", + "description": "an optional account for the vpn user. Must be used with domainId.", "length": 255, - "name": "systemvmtype", + "name": "account", "required": false, "type": "string" }, { - "description": "is this a system vm offering", + "description": "username for the vpn user", "length": 255, - "name": "issystem", - "required": false, - "type": "boolean" + "name": "username", + "required": true, + "type": "string" }, { - "description": "", + "description": "add vpn user to the specific project", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "name of the service offering", + "description": "password for the username", "length": 255, - "name": "name", - "required": false, + "name": "password", + "required": true, "type": "string" }, { - "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "isrecursive", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" } ], - "related": "updateServiceOffering", + "related": "", "response": [ { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": "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", + "description": "the username of the vpn user", + "name": "username", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" - }, - { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "the vpn userID", + "name": "id", + "type": "string" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", + "type": "string" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", + "type": "string" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, + {} + ] + }, + { + "description": "Deletes a project role permission in the project", + "isasync": false, + "name": "deleteProjectRolePermission", + "params": [ { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "ID of the project role permission to be deleted", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, + "description": "ID of the project where the project role permission is to be deleted", + "length": 255, + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" + } + ], + "response": [ {}, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "any text associated with the success or failure", + "name": "displaytext", "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 io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" - }, - { - "description": "the number of CPU", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" - }, - { - "description": "the ha support in the service offering", - "name": "offerha", - "type": "boolean" - }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "is this a default system vm offering", - "name": "defaultuse", + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" - }, + } + ], + "since": "4.15.0" + }, + { + "description": "Updates the quarantine end date for the given public IP address.", + "isasync": false, + "name": "updateQuarantinedIp", + "params": [ { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "The date when the quarantine will no longer be active.", + "length": 255, + "name": "enddate", + "required": true, + "type": "date" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" }, { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" - }, + "description": "The ID of the public IP address in active quarantine.", + "length": 255, + "name": "id", + "related": "updateQuarantinedIp", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", + "type": "string" }, { - "description": "the date this service offering was created", + "description": "When the quarantine was created.", "name": "created", "type": "date" }, { - "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": "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": "When the quarantine was removed.", + "name": "removed", + "type": "date" }, { - "description": "the id of the service offering", + "description": "ID of the quarantine process.", "name": "id", "type": "string" }, - { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - {}, - { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", - "type": "string" + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" }, + {}, { - "description": "the tags for the service offering", - "name": "storagetags", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" - }, - { - "description": "is true if the offering is customized", - "name": "iscustomized", - "type": "boolean" - }, - { - "description": "the name of the service offering", - "name": "name", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" - }, - { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" - }, - { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" - }, - { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "type": "boolean" - }, + } + ], + "since": "4.19" + }, + { + "description": "Updates a template to VNF template or attributes of a VNF template.", + "isasync": false, + "name": "updateVnfTemplate", + "params": [ { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "the format for the image", + "length": 255, + "name": "format", + "required": false, + "type": "string" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", + "length": 255, + "name": "templatetype", + "required": false, "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" + "description": "the ID of the image file", + "length": 255, + "name": "id", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "required": true, + "type": "uuid" }, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", - "type": "string" - } - ] - }, - { - "description": "Import virtual machine from a unmanaged host into CloudStack", - "isasync": true, - "name": "importVm", - "params": [ + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, { - "description": "the name of the instance as it is known to the hypervisor", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "description": "VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue. Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC", "length": 255, - "name": "datadiskofferinglist", + "name": "vnfnics", "required": false, "type": "map" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "migrateallowed", + "name": "isrouting", "required": false, "type": "boolean" }, { - "description": "the cluster ID", + "description": "VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0", "length": 255, - "name": "clusterid", - "related": "", - "required": true, - "type": "uuid" + "name": "vnfdetails", + "required": false, + "type": "map" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) optional - the host to perform the virt-v2v migration from VMware to KVM.", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "convertinstancehostid", - "related": "", + "name": "requireshvm", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Host where local disk is located", + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "hostid", + "name": "ostypeid", "related": "", "required": false, "type": "uuid" }, { - "description": "the password for the host", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "password", + "name": "bootable", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "VM nic to network id mapping using keys nic and network", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "nicnetworklist", + "name": "sshkeyenabled", "required": false, - "type": "map" - }, - { - "description": "Source location for Import", - "length": 255, - "name": "importsource", - "required": true, - "type": "string" + "type": "boolean" }, { - "description": "Temp Path on external host for disk image copy", + "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", "length": 255, - "name": "temppath", + "name": "cleanupvnfnics", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the username for the host", + "description": "the name of the image file", "length": 255, - "name": "username", + "name": "name", "required": false, "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", "required": false, "type": "string" }, { - "description": "the network ID", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "passwordenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Shared storage pool where disk is located", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "storageid", - "related": "", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20", + "type": "string" }, { - "description": "the zone ID", + "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "cleanupvnfdetails", + "required": false, + "type": "boolean" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "nicipaddresslist", + "name": "details", "required": false, "type": "map" }, { - "description": "the host name or IP address", + "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": "host", + "name": "cleanupdetails", "required": false, + "type": "boolean" + } + ], + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "response": [ + { + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, + {}, + {}, { - "description": "the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the host name of the instance", - "length": 255, - "name": "hostname", - "required": false, + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) Name of VMware cluster.", - "length": 255, - "name": "clustername", - "required": false, + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", - "length": 255, - "name": "vcenter", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", - "length": 255, - "name": "forced", - "required": false, + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", - "required": false, - "type": "uuid" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "hypervisor type of the host", - "length": 255, - "name": "hypervisor", - "required": true, + "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": "used to specify the custom parameters.", - "length": 255, - "name": "details", - "required": false, - "type": "map" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "import instance for the project", - "length": 255, + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the project id of the template", "name": "projectid", - "related": "", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "import instance to the domain specified", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) Name of VMware datacenter.", - "length": 255, - "name": "datacentername", - "required": false, + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", - "length": 255, - "name": "convertinstancepoolid", - "related": "", - "required": false, - "type": "uuid" + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "the display name of the instance", - "length": 255, - "name": "displayname", - "required": false, + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "path of the disk image", - "length": 255, - "name": "diskpath", - "required": false, + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) VMware ESXi host IP/Name.", - "length": 255, - "name": "hostip", - "required": false, + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "(only for importing migrated VMs from Vmware to KVM) UUID of a linked existing vCenter", - "length": 255, - "name": "existingvcenterid", - "related": "", - "required": false, - "type": "uuid" - } - ], - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", - "response": [ + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "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 host for the virtual machine", - "name": "hostid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", + "name": "userdataparams", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "the date this template was removed", + "name": "removed", "type": "date" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", + "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + } + ], + "since": "4.19.0" + }, + { + "description": "Updates VPC offering", + "isasync": true, + "name": "updateVPCOffering", + "params": [ + { + "description": "the id of the VPC offering", + "length": 255, + "name": "id", + "related": "updateVPCOffering", + "required": true, + "type": "uuid" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "sort key of the VPC offering, integer", + "length": 255, + "name": "sortkey", + "required": false, "type": "integer" }, - {}, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", + "required": false, + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the name of the VPC offering", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "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 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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - } - ], - "type": "set" + "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 amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the display text of the VPC offering", + "length": 255, + "name": "displaytext", + "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(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the vpc offering", + "name": "name", "type": "string" }, { @@ -138322,971 +153290,1449 @@ "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 project ID of the affinity group", - "name": "projectid", - "type": "string" - }, - { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", + "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, + {}, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the id of the vpc offering", + "name": "id", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "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 template for the virtual machine", - "name": "templatename", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "type": "boolean" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", + "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of supported services", + "name": "service", "response": [ { - "description": "the list of resource tags associated with the rule", - "name": "tags", + "description": "the service provider name", + "name": "provider", "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], - "type": "set" + "type": "list" }, { - "description": "the name of the security group", + "description": "the service name", "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 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the 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 account owning the security group", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of capabilities", + "name": "capability", "response": [ { - "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the capability value", + "name": "value", "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": "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": "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": "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" - } - ], - "type": "set" } ], - "type": "set" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "type": "list" } ], - "type": "set" + "type": "list" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the 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 name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, + "description": "true if vpc offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + {} + ] + }, + { + "description": "Lists user two factor authenticator providers", + "isasync": false, + "name": "listUserTwoFactorAuthenticatorProviders", + "params": [ + { + "description": "List user two factor authenticator provider by name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the user two factor authenticator provider name", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the description of the user two factor authenticator provider", + "name": "description", + "type": "string" + } + ], + "since": "4.18.0" + }, + { + "description": "Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", + "isasync": true, + "name": "scaleVirtualMachine", + "params": [ + { + "description": "the ID of the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "The ID of the virtual machine", + "length": 255, + "name": "id", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", + "length": 255, + "name": "automigrate", + "required": false, + "since": "4.17", + "type": "boolean" + }, + { + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", + "required": false, + "since": "4.17", + "type": "long" + }, + { + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, + { + "description": "Verify OK to Shrink", + "length": 255, + "name": "shrinkok", + "required": false, + "since": "4.17", + "type": "boolean" + }, + { + "description": "New minimum number of IOPS for the custom disk offering", + "length": 255, + "name": "miniops", + "required": false, + "since": "4.17", + "type": "long" + } + ], + "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": "Updates egress firewall rule ", + "isasync": true, + "name": "updateEgressFirewallRule", + "params": [ + { + "description": "an optional field, whether to the display the rule to the end user or not", + "length": 255, + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" + }, + { + "description": "the ID of the egress firewall rule", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "length": 255, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" + } + ], + "related": "", + "response": [ + { + "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 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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "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 starting port of firewall rule's port range", + "name": "startport", + "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 network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the state of the rule", + "name": "state", "type": "string" }, + {}, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + } + ], + "since": "4.4" + }, + { + "description": "Lists all supported OS categories for this cloud.", + "isasync": false, + "name": "listOsCategories", + "params": [ + { + "description": "list os category by name", + "length": 255, + "name": "name", + "required": false, + "since": "3.0.1", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the ID of the virtual machine", + "description": "list Os category by id", + "length": 255, "name": "id", + "related": "listOsCategories", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the name of the OS category", + "name": "name", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the OS category", + "name": "id", "type": "string" }, + {}, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ] + }, + { + "description": "Lists all available service offerings.", + "isasync": false, + "name": "listServiceOfferings", + "params": [ + { + "description": "The ID of the template that listed offerings must support", + "length": 255, + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "required": false, + "since": "4.20.0", + "type": "uuid" + }, + { + "description": "is this a system vm offering", + "length": 255, + "name": "issystem", + "required": false, "type": "boolean" }, { - "description": "the account associated with the virtual machine", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, "name": "account", + "required": false, "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "length": 255, + "name": "state", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.", + "length": 255, + "name": "virtualmachineid", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "ID of the service offering", + "length": 255, + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "listed offerings support root disk encryption", + "length": 255, + "name": "encryptroot", + "required": false, + "since": "4.18", + "type": "boolean" + }, + { + "description": "the CPU number that listed offerings must support", + "length": 255, + "name": "cpunumber", + "required": false, + "since": "4.15", + "type": "integer" + }, + { + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "length": 255, + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "the storage type of the service offering. Values are local and shared.", + "length": 255, + "name": "storagetype", + "required": false, + "since": "4.19", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the CPU speed that listed offerings must support", + "length": 255, + "name": "cpuspeed", + "required": false, + "since": "4.15", + "type": "integer" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "id of zone disk offering is associated with", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "since": "4.13", + "type": "uuid" + }, + { + "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 service offering of the virtual machine", - "name": "serviceofferingid", + "description": "name of the service offering", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the memory allocated for the virtual machine", + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the RAM memory that listed offering must support", + "length": 255, "name": "memory", + "required": false, + "since": "4.15", "type": "integer" - }, + } + ], + "related": "updateServiceOffering", + "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" + }, + { + "description": "is true if the offering is customized", + "name": "iscustomized", "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" + }, + { + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the memory in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" + }, + { + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" + }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, - {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" + }, + { + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "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": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", + "type": "boolean" + }, + { + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" + }, + { + "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": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" + }, + {}, + { + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", "type": "map" }, { - "description": "the project name of the vm", - "name": "project", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" + }, + { + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + { + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the name of the service offering", + "name": "name", + "type": "string" + }, + { + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "state of the service offering", + "name": "state", + "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": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" + }, + { + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" + }, + { + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", + "type": "string" + }, + { + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "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 min iops of the disk offering", + "name": "miniops", + "type": "long" + }, + { + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" + }, + { + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" + }, + { + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" } - ], - "since": "4.19.0" + ] }, { - "description": "Removes a load balancer rule association with global load balancer rule", + "description": "Import virtual machine from a unmanaged host into CloudStack", "isasync": true, - "name": "removeFromGlobalLoadBalancerRule", + "name": "importVm", "params": [ { - "description": "the list load balancer rules that will be assigned to global load balancer rule", + "description": "the display name of the instance", "length": 255, - "name": "loadbalancerrulelist", - "related": "", + "name": "displayname", + "required": false, + "type": "string" + }, + { + "description": "the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "updateServiceOffering", "required": true, - "type": "list" + "type": "uuid" }, { - "description": "The ID of the load balancer rule", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "id", + "name": "templateid", + "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "required": false, + "type": "uuid" + }, + { + "description": "the username for the host", + "length": 255, + "name": "username", + "required": false, + "type": "string" + }, + { + "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", + "length": 255, + "name": "hostip", + "required": false, + "type": "string" + }, + { + "description": "VM nic to ip address mapping using keys nic, ip4Address", + "length": 255, + "name": "nicipaddresslist", + "required": false, + "type": "map" + }, + { + "description": "(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v migration from VMware to KVM.", + "length": 255, + "name": "convertinstancehostid", "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, + "type": "string" + }, + { + "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", + "length": 255, + "name": "clustername", + "required": false, + "type": "string" + }, + { + "description": "the password for the host", + "length": 255, + "name": "password", + "required": false, + "type": "string" + }, + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" - } - ], - "response": [ + }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Shared storage pool where disk is located", + "length": 255, + "name": "storageid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "(only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "length": 255, + "name": "vcenter", + "required": false, + "type": "string" + }, + { + "description": "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated", + "length": 255, + "name": "forced", + "required": false, "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the host name of the instance", + "length": 255, + "name": "hostname", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", + "required": false, + "type": "uuid" }, - {}, - {} - ] - }, - { - "description": "Lists affinity group types available", - "isasync": false, - "name": "listAffinityGroupTypes", - "params": [ { - "description": "", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "pagesize", + "name": "nicnetworklist", "required": false, - "type": "integer" + "type": "map" }, { - "description": "", + "description": "used to specify the custom parameters.", "length": 255, - "name": "page", + "name": "details", "required": false, - "type": "integer" + "type": "map" }, { - "description": "List by keyword", + "description": "Temp Path on external host for disk image copy", "length": 255, - "name": "keyword", + "name": "temppath", + "required": false, + "type": "string" + }, + { + "description": "the host name or IP address", + "length": 255, + "name": "host", + "required": false, + "type": "string" + }, + { + "description": "Source location for Import", + "length": 255, + "name": "importsource", + "required": true, + "type": "string" + }, + { + "description": "(only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.", + "length": 255, + "name": "convertinstancepoolid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "(only for importing VMs from VMware to KVM) optional - if true, forces MS to import VM file(s) to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not.", + "length": 255, + "name": "forcemstoimportvmfiles", + "required": false, + "type": "boolean" + }, + { + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "length": 255, + "name": "datadiskofferinglist", + "required": false, + "type": "map" + }, + { + "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "length": 255, + "name": "migrateallowed", + "required": false, + "type": "boolean" + }, + { + "description": "import instance to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "Host where local disk is located", + "length": 255, + "name": "hostid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "hypervisor type of the host", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" + }, + { + "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", + "length": 255, + "name": "existingvcenterid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "", + "required": true, + "type": "uuid" + }, + { + "description": "import instance for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the instance as it is known to the hypervisor", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "path of the disk image", + "length": 255, + "name": "diskpath", "required": false, "type": "string" } ], - "related": "", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances", "response": [ - {}, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "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 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 account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" - } - ] - }, - { - "description": "Lists all the system wide capacities.", - "isasync": false, - "name": "listCapacity", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "the 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": "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": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", - "length": 255, - "name": "type", - "required": false, + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "Sort the results. Available values: Usage", - "length": 255, - "name": "sortby", - "required": false, - "since": "3.0.0", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "lists capacity by the Zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "lists capacity by the Pod ID", - "length": 255, - "name": "podid", - "related": "", - "required": false, - "type": "uuid" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "lists capacity by the Cluster ID", - "length": 255, - "name": "clusterid", - "related": "", - "required": false, - "since": "3.0.0", - "type": "uuid" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" }, + {}, { - "description": "recalculate capacities and fetch the latest", - "length": 255, - "name": "fetchlatest", - "required": false, - "since": "3.0.0", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" - } - ], - "related": "", - "response": [ - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -139294,182 +154740,119 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, { - "description": "the Pod name", - "name": "podname", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, - {} - ] - }, - { - "description": "Starts a virtual machine.", - "isasync": true, - "name": "startVirtualMachine", - "params": [ - { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "hostid", - "related": "", - "required": false, - "since": "3.0.1", - "type": "uuid" - }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", - "length": 255, - "name": "deploymentplanner", - "required": false, - "since": "4.4", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "related": "scaleVirtualMachine,startVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", - "required": true, - "type": "uuid" - }, - { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "podid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "Boot into hardware setup menu or not", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, + {}, { - "description": "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the VM by normal process.", - "length": 255, - "name": "considerlasthost", - "required": false, - "since": "4.18.0", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", - "length": 255, - "name": "clusterid", - "related": "", - "required": false, - "type": "uuid" - } - ], - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", - "response": [ - { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { @@ -139477,191 +154860,105 @@ "name": "project", "type": "string" }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "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 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": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the 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 total number of network traffic bytes sent", "name": "sentbytes", "type": "long" }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, { "description": "the id of userdata used for the VM", "name": "userdataid", "type": "string" }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, { "description": "the account associated with the virtual machine", "name": "account", "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "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": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 Secondary ipv4 addr of nic", "name": "secondaryip", "type": "list" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", @@ -139669,53 +154966,58 @@ "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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 traffic type of the nic", - "name": "traffictype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -139724,8 +155026,8 @@ "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -139734,43 +155036,53 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "name": "isdefault", + "type": "boolean" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -139779,56 +155091,36 @@ "type": "integer" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" } ], "type": "set" }, { - "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", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -139837,29 +155129,34 @@ "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { "description": "the name of the backup offering of the virtual machine", @@ -139867,160 +155164,128 @@ "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the 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": "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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, { "description": "the protocol of the security group rule", "name": "protocol", @@ -140032,9 +155297,9 @@ "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { "description": "the starting IP of the security group rule", @@ -140042,42 +155307,42 @@ "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the 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 project name where tag belongs to", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -140086,59 +155351,39 @@ "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "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": "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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { @@ -140146,13 +155391,18 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -140161,13 +155411,18 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -140180,11 +155435,6 @@ "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", @@ -140198,47 +155448,82 @@ ], "type": "set" }, + { + "description": "the ID of the security group", + "name": "id", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the 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 project id of the group", + "name": "projectid", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" + }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", "response": [ { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -140247,8 +155532,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -140256,6 +155546,11 @@ "name": "account", "type": "string" }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "tag key name", "name": "key", @@ -140265,23 +155560,23 @@ "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 code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -140290,168 +155585,295 @@ "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { "description": "security group name", "name": "securitygroupname", "type": "string" - }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" } ], "type": "set" - }, - { - "description": "the ID of the security group", - "name": "id", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" } ], "type": "set" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Removes a load balancer rule association with global load balancer rule", + "isasync": true, + "name": "removeFromGlobalLoadBalancerRule", + "params": [ + { + "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 global load balancer rule", + "length": 255, + "name": "loadbalancerrulelist", + "related": "", + "required": true, + "type": "list" + } + ], + "response": [ + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, + {}, + {} + ] + }, + { + "description": "Lists affinity group types available", + "isasync": false, + "name": "listAffinityGroupTypes", + "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "the type of the affinity group", + "name": "type", "type": "string" + } + ] + }, + { + "description": "Lists all the system wide capacities.", + "isasync": false, + "name": "listCapacity", + "params": [ + { + "description": "lists capacity by the Pod ID", + "length": 255, + "name": "podid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the name of the affinity group", - "name": "name", - "type": "string" - }, - { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - }, - { - "description": "the 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" - }, - { - "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 project name of the affinity group", - "name": "project", - "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" - } - ], - "type": "set" + "description": "Tag for the resource type", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "recalculate capacities and fetch the latest", + "length": 255, + "name": "fetchlatest", + "required": false, + "since": "3.0.0", + "type": "boolean" + }, + { + "description": "lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.", + "length": 255, + "name": "type", + "required": false, + "type": "integer" + }, + { + "description": "lists capacity by the Cluster ID", + "length": 255, + "name": "clusterid", + "related": "", + "required": false, + "since": "3.0.0", + "type": "uuid" + }, + { + "description": "lists capacity by the Zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Sort the results. Available values: Usage", + "length": 255, + "name": "sortby", + "required": false, + "since": "3.0.0", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the capacity type", + "name": "type", + "type": "short" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the capacity name", + "name": "name", "type": "string" }, {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the percentage of capacity currently in use", + "name": "percentused", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the Zone name", + "name": "zonename", "type": "string" + }, + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" } ] }, @@ -140467,22 +155889,6 @@ "required": false, "type": "string" }, - { - "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", - "length": 255, - "name": "storagetags", - "required": false, - "since": "4.16", - "type": "string" - }, - { - "description": "the host tag for this service offering.", - "length": 255, - "name": "hosttags", - "required": false, - "since": "4.16", - "type": "string" - }, { "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 4096, @@ -140491,11 +155897,10 @@ "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "state of the service offering", "length": 255, - "name": "zoneid", + "name": "state", "required": false, - "since": "4.13", "type": "string" }, { @@ -140506,6 +155911,14 @@ "required": true, "type": "uuid" }, + { + "description": "Whether to cleanup VM and its associated resource upon expunge", + "length": 255, + "name": "purgeresources", + "required": false, + "since": "4.20", + "type": "boolean" + }, { "description": "the name of the service offering to be updated", "length": 255, @@ -140514,69 +155927,88 @@ "type": "string" }, { - "description": "sort key of the service offering, integer", + "description": "the host tag for this service offering.", "length": 255, - "name": "sortkey", + "name": "hosttags", "required": false, - "type": "integer" - } - ], - "related": "", - "response": [ - { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "since": "4.16", "type": "string" }, { - "description": "the tags for the service offering", + "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": "the memory in MB", - "name": "memory", + "description": "sort key of the service offering, integer", + "length": 255, + "name": "sortkey", + "required": false, "type": "integer" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", - "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" + } + ], + "related": "", + "response": [ { "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": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" + }, + { + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" + }, + { + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" }, { "description": "additional key/value details tied with this service offering", "name": "serviceofferingdetails", "type": "map" }, + {}, { - "description": "the number of CPU", - "name": "cpunumber", - "type": "integer" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" + }, + { + "description": "state of the service offering", + "name": "state", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" + }, + { + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, { @@ -140584,80 +156016,110 @@ "name": "diskBytesWriteRateMaxLength", "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 min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "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": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "the host tag for the service offering", - "name": "hosttags", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "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 the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", + "name": "diskofferingstrictness", + "type": "boolean" + }, + { + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the memory in MB", + "name": "memory", + "type": "integer" + }, + { + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { @@ -140666,129 +156128,114 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "the name of the service offering", - "name": "name", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" + }, + { + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "the tags for the service offering", + "name": "storagetags", + "type": "string" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, + { + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" }, { "description": "bytes read rate of the service offering", "name": "diskBytesReadRate", "type": "long" }, - { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" - }, { "description": "burst bytes write rate of the disk offering", "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", - "type": "boolean" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", "type": "boolean" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", - "type": "long" - }, - { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" - }, - { - "description": "True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed", - "name": "diskofferingstrictness", - "type": "boolean" - }, - { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "name": "hypervisorsnapshotreserve", + "type": "integer" } ] }, @@ -140801,7 +156248,7 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", + "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances", "required": true, "type": "uuid" }, @@ -140813,27 +156260,46 @@ "type": "boolean" } ], - "related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance", + "related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,deployVnfAppliance,listVnfAppliances", "response": [ { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, - {}, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { @@ -140842,9 +156308,409 @@ "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", + "name": "templateid", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ip address of the nic", + "name": "ipaddress", + "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": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "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": "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ], + "type": "set" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the 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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" + }, + {}, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { "description": "device ID of the root volume", @@ -140852,246 +156718,237 @@ "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, + {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "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", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the 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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, { "description": "the group ID of the virtual machine", "name": "groupid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingid", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { @@ -141100,265 +156957,118 @@ "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "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": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - }, - { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the type of the nic", - "name": "type", - "type": "string" - }, - { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - } - ], - "type": "set" + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag 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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" - } - ], - "type": "set" - }, - { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" }, { - "description": "the description of the security group", - "name": "description", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the list of ingress rules associated with the security group", - "name": "ingressrule", + "description": "the list of egress rules associated with the security group", + "name": "egressrule", "response": [ { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "security group name", + "name": "securitygroupname", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" }, { @@ -141366,13 +157076,38 @@ "name": "account", "type": "string" }, + { + "description": "the id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" + }, + { + "description": "the 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -141381,8 +157116,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -141391,124 +157126,47 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "the 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" - } - ], - "type": "set" - }, - { - "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" } ], "type": "set" @@ -141519,8 +157177,18 @@ "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -141529,34 +157197,24 @@ "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the list of egress rules associated with the security group", - "name": "egressrule", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, { "description": "security group name", "name": "securitygroupname", @@ -141568,14 +157226,14 @@ "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", @@ -141586,29 +157244,24 @@ "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -141617,137 +157270,72 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "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 id of the security group rule", + "name": "ruleid", + "type": "string" + }, + { + "description": "the protocol of the security group rule", + "name": "protocol", + "type": "string" + }, { "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "the CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "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 name of the security group", - "name": "name", - "type": "string" } ], "type": "set" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "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": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", + "name": "diskofferingname", "type": "string" }, { @@ -141755,96 +157343,15 @@ "name": "jobid", "type": "string" }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, { "description": "the name of userdata used for the VM", "name": "userdataname", "type": "string" }, { - "description": "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", - "name": "diskofferingname", - "type": "string" - }, - {}, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" } ] }, @@ -141860,6 +157367,13 @@ "required": true, "type": "string" }, + { + "description": "Description of the network ACL list", + "length": 255, + "name": "description", + "required": false, + "type": "string" + }, { "description": "ID of the VPC associated with this network ACL list", "length": 255, @@ -141875,13 +157389,6 @@ "required": false, "since": "4.4", "type": "boolean" - }, - { - "description": "Description of the network ACL list", - "length": 255, - "name": "description", - "required": false, - "type": "string" } ], "related": "", @@ -141892,10 +157399,17 @@ "type": "string" }, { - "description": "Description of the ACL", - "name": "description", + "description": "the Name of the ACL", + "name": "name", "type": "string" }, + {}, + { + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", + "type": "string" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -141907,29 +157421,22 @@ "type": "string" }, { - "description": "the ID of the ACL", - "name": "id", - "type": "string" - }, - { - "description": "the Name of the ACL", - "name": "name", + "description": "Description of the ACL", + "name": "description", "type": "string" }, { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", + "description": "the ID of the ACL", + "name": "id", "type": "string" }, { "description": "is ACL for display to the regular user", "name": "fordisplay", "type": "boolean" - }, - {}, - {} + } ] } ], - "count": 754 + "count": 812 } diff --git a/test/UsageService_test.go b/test/UsageService_test.go index bd7a1e3a..0f51f75a 100644 --- a/test/UsageService_test.go +++ b/test/UsageService_test.go @@ -93,7 +93,7 @@ func TestUsageService(t *testing.T) { if _, ok := response["generateUsageRecords"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.Usage.NewGenerateUsageRecordsParams("enddate", "startdate") + p := client.Usage.NewGenerateUsageRecordsParams() _, err := client.Usage.GenerateUsageRecords(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/VPCService_test.go b/test/VPCService_test.go index d045a897..ec70274c 100644 --- a/test/VPCService_test.go +++ b/test/VPCService_test.go @@ -69,7 +69,7 @@ func TestVPCService(t *testing.T) { if _, ok := response["createVPC"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.VPC.NewCreateVPCParams("cidr", "displaytext", "name", "vpcofferingid", "zoneid") + p := client.VPC.NewCreateVPCParams("displaytext", "name", "vpcofferingid", "zoneid") r, err := client.VPC.CreateVPC(p) if err != nil { t.Errorf(err.Error()) @@ -84,7 +84,7 @@ func TestVPCService(t *testing.T) { if _, ok := response["createVPCOffering"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.VPC.NewCreateVPCOfferingParams("displaytext", "name", []string{}) + p := client.VPC.NewCreateVPCOfferingParams("displaytext", "name") r, err := client.VPC.CreateVPCOffering(p) if err != nil { t.Errorf(err.Error())